fastly 7.0.0 → 7.1.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +19 -0
- data/Gemfile.lock +1 -1
- data/README.md +7 -2
- data/docs/Backend.md +1 -0
- data/docs/BackendApi.md +4 -0
- data/docs/BackendResponse.md +1 -0
- data/docs/EventsApi.md +8 -0
- data/docs/LoggingNewrelicotlpAdditional.md +13 -0
- data/docs/LoggingNewrelicotlpApi.md +252 -0
- data/docs/LoggingNewrelicotlpResponse.md +22 -0
- data/docs/SecretStoreApi.md +3 -3
- data/docs/TlsDomainsApi.md +2 -2
- data/docs/TlsSubscriptionsApi.md +4 -4
- data/lib/fastly/api/backend_api.rb +16 -0
- data/lib/fastly/api/events_api.rb +12 -0
- data/lib/fastly/api/logging_newrelicotlp_api.rb +473 -0
- data/lib/fastly/api/rate_limiter_api.rb +2 -2
- data/lib/fastly/api/secret_store_api.rb +2 -2
- data/lib/fastly/api/tls_domains_api.rb +2 -2
- data/lib/fastly/api/tls_subscriptions_api.rb +4 -4
- data/lib/fastly/configuration.rb +30 -0
- data/lib/fastly/models/backend.rb +29 -1
- data/lib/fastly/models/backend_response.rb +29 -1
- data/lib/fastly/models/logging_newrelicotlp_additional.rb +288 -0
- data/lib/fastly/models/logging_newrelicotlp_response.rb +417 -0
- data/lib/fastly/models/rate_limiter.rb +2 -2
- data/lib/fastly/models/rate_limiter_response.rb +2 -2
- data/lib/fastly/version.rb +1 -1
- data/lib/fastly.rb +3 -0
- data/sig.json +1 -1
- metadata +8 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 68e8838b14560a805edeee4b5b98b0551631fb3e08a8c413e4c0295a188f3552
|
4
|
+
data.tar.gz: 77af692b4e7b48508e661cfc61863cb932a4aa1c75ab67913d861bb0d798f319
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ab8de311186aac5f7009ab67c7ac2d38bac773e52c2a0982c83e6e556f5f53d1e9d1149864350fa7f59f15023a16aadba42712450199b58686374e3b6e3659f8
|
7
|
+
data.tar.gz: 2304c5196c3d20ff4444e98fb46c0097e81d532e2cde25cf6880455ca661055ce654a4e1ec17b62646166d7a3c125d87a39d649a1887bd6becbee01feed9bb01
|
data/CHANGELOG.md
CHANGED
@@ -1,5 +1,24 @@
|
|
1
1
|
# Changelog
|
2
2
|
|
3
|
+
## [v7.1.1](https://github.com/fastly/fastly-ruby/releases/tag/release/v7.1.1) (2023-09-01)
|
4
|
+
|
5
|
+
**Enhancements:**
|
6
|
+
|
7
|
+
- feat(events): support extra created_at filters.
|
8
|
+
|
9
|
+
## [v7.1.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v7.1.0) (2023-09-01)
|
10
|
+
|
11
|
+
**Enhancements:**
|
12
|
+
|
13
|
+
- feat(backend): support share_key field.
|
14
|
+
- feat(events): support extra created_at filters.
|
15
|
+
- feat(logging/newrelic): add OTLP endpoints.
|
16
|
+
- feat(tls/subscriptions): support self_managed_http_challenge field.
|
17
|
+
|
18
|
+
**Documentation:**
|
19
|
+
|
20
|
+
- doc(secretstore): correct description for GET endpoint.
|
21
|
+
|
3
22
|
## [v7.0.0](https://github.com/fastly/fastly-ruby/releases/tag/release/v7.0.0) (2023-07-31)
|
4
23
|
|
5
24
|
**Breaking:**
|
data/Gemfile.lock
CHANGED
data/README.md
CHANGED
@@ -8,7 +8,7 @@ A Ruby client library for interacting with most facets of the [Fastly API](https
|
|
8
8
|
To install via RubyGems, add the following to your project's `Gemfile`:
|
9
9
|
|
10
10
|
```ruby
|
11
|
-
gem 'fastly', '~> 7.
|
11
|
+
gem 'fastly', '~> 7.1.1'
|
12
12
|
```
|
13
13
|
|
14
14
|
Then run `bundle install`.
|
@@ -348,6 +348,11 @@ Class | Method | Description
|
|
348
348
|
[*Fastly::LoggingNewrelicApi*](docs/LoggingNewrelicApi.md) | [**get_log_newrelic**](docs/LoggingNewrelicApi.md#get_log_newrelic) | Get a New Relic log endpoint
|
349
349
|
[*Fastly::LoggingNewrelicApi*](docs/LoggingNewrelicApi.md) | [**list_log_newrelic**](docs/LoggingNewrelicApi.md#list_log_newrelic) | List New Relic log endpoints
|
350
350
|
[*Fastly::LoggingNewrelicApi*](docs/LoggingNewrelicApi.md) | [**update_log_newrelic**](docs/LoggingNewrelicApi.md#update_log_newrelic) | Update a New Relic log endpoint
|
351
|
+
[*Fastly::LoggingNewrelicotlpApi*](docs/LoggingNewrelicotlpApi.md) | [**create_log_newrelicotlp**](docs/LoggingNewrelicotlpApi.md#create_log_newrelicotlp) | Create a New Relic OTLP endpoint
|
352
|
+
[*Fastly::LoggingNewrelicotlpApi*](docs/LoggingNewrelicotlpApi.md) | [**delete_log_newrelicotlp**](docs/LoggingNewrelicotlpApi.md#delete_log_newrelicotlp) | Delete a New Relic OTLP endpoint
|
353
|
+
[*Fastly::LoggingNewrelicotlpApi*](docs/LoggingNewrelicotlpApi.md) | [**get_log_newrelicotlp**](docs/LoggingNewrelicotlpApi.md#get_log_newrelicotlp) | Get a New Relic OTLP endpoint
|
354
|
+
[*Fastly::LoggingNewrelicotlpApi*](docs/LoggingNewrelicotlpApi.md) | [**list_log_newrelicotlp**](docs/LoggingNewrelicotlpApi.md#list_log_newrelicotlp) | List New Relic OTLP endpoints
|
355
|
+
[*Fastly::LoggingNewrelicotlpApi*](docs/LoggingNewrelicotlpApi.md) | [**update_log_newrelicotlp**](docs/LoggingNewrelicotlpApi.md#update_log_newrelicotlp) | Update a New Relic log endpoint
|
351
356
|
[*Fastly::LoggingOpenstackApi*](docs/LoggingOpenstackApi.md) | [**create_log_openstack**](docs/LoggingOpenstackApi.md#create_log_openstack) | Create an OpenStack log endpoint
|
352
357
|
[*Fastly::LoggingOpenstackApi*](docs/LoggingOpenstackApi.md) | [**delete_log_openstack**](docs/LoggingOpenstackApi.md#delete_log_openstack) | Delete an OpenStack log endpoint
|
353
358
|
[*Fastly::LoggingOpenstackApi*](docs/LoggingOpenstackApi.md) | [**get_log_openstack**](docs/LoggingOpenstackApi.md#get_log_openstack) | Get an OpenStack log endpoint
|
@@ -442,7 +447,7 @@ Class | Method | Description
|
|
442
447
|
[*Fastly::SecretStoreApi*](docs/SecretStoreApi.md) | [**client_key**](docs/SecretStoreApi.md#client_key) | Create new client key
|
443
448
|
[*Fastly::SecretStoreApi*](docs/SecretStoreApi.md) | [**create_secret_store**](docs/SecretStoreApi.md#create_secret_store) | Create new secret store
|
444
449
|
[*Fastly::SecretStoreApi*](docs/SecretStoreApi.md) | [**delete_secret_store**](docs/SecretStoreApi.md#delete_secret_store) | Delete secret store
|
445
|
-
[*Fastly::SecretStoreApi*](docs/SecretStoreApi.md) | [**get_secret_store**](docs/SecretStoreApi.md#get_secret_store) |
|
450
|
+
[*Fastly::SecretStoreApi*](docs/SecretStoreApi.md) | [**get_secret_store**](docs/SecretStoreApi.md#get_secret_store) | Get secret store by ID
|
446
451
|
[*Fastly::SecretStoreApi*](docs/SecretStoreApi.md) | [**get_secret_stores**](docs/SecretStoreApi.md#get_secret_stores) | Get all secret stores
|
447
452
|
[*Fastly::SecretStoreApi*](docs/SecretStoreApi.md) | [**signing_key**](docs/SecretStoreApi.md#signing_key) | Get public key
|
448
453
|
[*Fastly::SecretStoreItemApi*](docs/SecretStoreItemApi.md) | [**create_secret**](docs/SecretStoreItemApi.md#create_secret) | Create a new secret in a store.
|
data/docs/Backend.md
CHANGED
@@ -23,6 +23,7 @@
|
|
23
23
|
| **override_host** | **String** | If set, will replace the client-supplied HTTP `Host` header on connections to this backend. Applied after VCL has been processed, so this setting will take precedence over changing `bereq.http.Host` in VCL. | [optional] |
|
24
24
|
| **port** | **Integer** | Port on which the backend server is listening for connections from Fastly. Setting `port` to 80 or 443 will also set `use_ssl` automatically (to false and true respectively), unless explicitly overridden by setting `use_ssl` in the same request. | [optional] |
|
25
25
|
| **request_condition** | **String** | Name of a Condition, which if satisfied, will select this backend during a request. If set, will override any `auto_loadbalance` setting. By default, the first backend added to a service is selected for all requests. | [optional] |
|
26
|
+
| **share_key** | **String** | Value that when shared across backends will enable those backends to share the same health check. | [optional] |
|
26
27
|
| **shield** | **String** | Identifier of the POP to use as a [shield](https://docs.fastly.com/en/guides/shielding). | [optional] |
|
27
28
|
| **ssl_ca_cert** | **String** | CA certificate attached to origin. | [optional] |
|
28
29
|
| **ssl_cert_hostname** | **String** | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | [optional] |
|
data/docs/BackendApi.md
CHANGED
@@ -51,6 +51,7 @@ opts = {
|
|
51
51
|
override_host: 'override_host_example', # String | If set, will replace the client-supplied HTTP `Host` header on connections to this backend. Applied after VCL has been processed, so this setting will take precedence over changing `bereq.http.Host` in VCL.
|
52
52
|
port: 56, # Integer | Port on which the backend server is listening for connections from Fastly. Setting `port` to 80 or 443 will also set `use_ssl` automatically (to false and true respectively), unless explicitly overridden by setting `use_ssl` in the same request.
|
53
53
|
request_condition: 'request_condition_example', # String | Name of a Condition, which if satisfied, will select this backend during a request. If set, will override any `auto_loadbalance` setting. By default, the first backend added to a service is selected for all requests.
|
54
|
+
share_key: 'share_key_example', # String | Value that when shared across backends will enable those backends to share the same health check.
|
54
55
|
shield: 'shield_example', # String | Identifier of the POP to use as a [shield](https://docs.fastly.com/en/guides/shielding).
|
55
56
|
ssl_ca_cert: 'ssl_ca_cert_example', # String | CA certificate attached to origin.
|
56
57
|
ssl_cert_hostname: 'ssl_cert_hostname_example', # String | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.
|
@@ -98,6 +99,7 @@ end
|
|
98
99
|
| **override_host** | **String** | If set, will replace the client-supplied HTTP `Host` header on connections to this backend. Applied after VCL has been processed, so this setting will take precedence over changing `bereq.http.Host` in VCL. | [optional] |
|
99
100
|
| **port** | **Integer** | Port on which the backend server is listening for connections from Fastly. Setting `port` to 80 or 443 will also set `use_ssl` automatically (to false and true respectively), unless explicitly overridden by setting `use_ssl` in the same request. | [optional] |
|
100
101
|
| **request_condition** | **String** | Name of a Condition, which if satisfied, will select this backend during a request. If set, will override any `auto_loadbalance` setting. By default, the first backend added to a service is selected for all requests. | [optional] |
|
102
|
+
| **share_key** | **String** | Value that when shared across backends will enable those backends to share the same health check. | [optional] |
|
101
103
|
| **shield** | **String** | Identifier of the POP to use as a [shield](https://docs.fastly.com/en/guides/shielding). | [optional] |
|
102
104
|
| **ssl_ca_cert** | **String** | CA certificate attached to origin. | [optional] |
|
103
105
|
| **ssl_cert_hostname** | **String** | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | [optional] |
|
@@ -272,6 +274,7 @@ opts = {
|
|
272
274
|
override_host: 'override_host_example', # String | If set, will replace the client-supplied HTTP `Host` header on connections to this backend. Applied after VCL has been processed, so this setting will take precedence over changing `bereq.http.Host` in VCL.
|
273
275
|
port: 56, # Integer | Port on which the backend server is listening for connections from Fastly. Setting `port` to 80 or 443 will also set `use_ssl` automatically (to false and true respectively), unless explicitly overridden by setting `use_ssl` in the same request.
|
274
276
|
request_condition: 'request_condition_example', # String | Name of a Condition, which if satisfied, will select this backend during a request. If set, will override any `auto_loadbalance` setting. By default, the first backend added to a service is selected for all requests.
|
277
|
+
share_key: 'share_key_example', # String | Value that when shared across backends will enable those backends to share the same health check.
|
275
278
|
shield: 'shield_example', # String | Identifier of the POP to use as a [shield](https://docs.fastly.com/en/guides/shielding).
|
276
279
|
ssl_ca_cert: 'ssl_ca_cert_example', # String | CA certificate attached to origin.
|
277
280
|
ssl_cert_hostname: 'ssl_cert_hostname_example', # String | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.
|
@@ -320,6 +323,7 @@ end
|
|
320
323
|
| **override_host** | **String** | If set, will replace the client-supplied HTTP `Host` header on connections to this backend. Applied after VCL has been processed, so this setting will take precedence over changing `bereq.http.Host` in VCL. | [optional] |
|
321
324
|
| **port** | **Integer** | Port on which the backend server is listening for connections from Fastly. Setting `port` to 80 or 443 will also set `use_ssl` automatically (to false and true respectively), unless explicitly overridden by setting `use_ssl` in the same request. | [optional] |
|
322
325
|
| **request_condition** | **String** | Name of a Condition, which if satisfied, will select this backend during a request. If set, will override any `auto_loadbalance` setting. By default, the first backend added to a service is selected for all requests. | [optional] |
|
326
|
+
| **share_key** | **String** | Value that when shared across backends will enable those backends to share the same health check. | [optional] |
|
323
327
|
| **shield** | **String** | Identifier of the POP to use as a [shield](https://docs.fastly.com/en/guides/shielding). | [optional] |
|
324
328
|
| **ssl_ca_cert** | **String** | CA certificate attached to origin. | [optional] |
|
325
329
|
| **ssl_cert_hostname** | **String** | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | [optional] |
|
data/docs/BackendResponse.md
CHANGED
@@ -23,6 +23,7 @@
|
|
23
23
|
| **override_host** | **String** | If set, will replace the client-supplied HTTP `Host` header on connections to this backend. Applied after VCL has been processed, so this setting will take precedence over changing `bereq.http.Host` in VCL. | [optional] |
|
24
24
|
| **port** | **Integer** | Port on which the backend server is listening for connections from Fastly. Setting `port` to 80 or 443 will also set `use_ssl` automatically (to false and true respectively), unless explicitly overridden by setting `use_ssl` in the same request. | [optional] |
|
25
25
|
| **request_condition** | **String** | Name of a Condition, which if satisfied, will select this backend during a request. If set, will override any `auto_loadbalance` setting. By default, the first backend added to a service is selected for all requests. | [optional] |
|
26
|
+
| **share_key** | **String** | Value that when shared across backends will enable those backends to share the same health check. | [optional] |
|
26
27
|
| **shield** | **String** | Identifier of the POP to use as a [shield](https://docs.fastly.com/en/guides/shielding). | [optional] |
|
27
28
|
| **ssl_ca_cert** | **String** | CA certificate attached to origin. | [optional] |
|
28
29
|
| **ssl_cert_hostname** | **String** | Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all. | [optional] |
|
data/docs/EventsApi.md
CHANGED
@@ -70,6 +70,10 @@ opts = {
|
|
70
70
|
filter_user_id: 'filter_user_id_example', # String | Limit the results returned to a specific user.
|
71
71
|
filter_token_id: 'filter_token_id_example', # String | Limit the returned events to a specific token.
|
72
72
|
filter_created_at: 'filter_created_at_example', # String | Limit the returned events to a specific time frame. Accepts sub-parameters: lt, lte, gt, gte (e.g., filter[created_at][gt]=2022-01-12).
|
73
|
+
filter_created_at_lte: 'filter_created_at_lte_example', # String | Return events on and before a date and time in ISO 8601 format.
|
74
|
+
filter_created_at_lt: 'filter_created_at_lt_example', # String | Return events before a date and time in ISO 8601 format.
|
75
|
+
filter_created_at_gte: 'filter_created_at_gte_example', # String | Return events on and after a date and time in ISO 8601 format.
|
76
|
+
filter_created_at_gt: 'filter_created_at_gt_example', # String | Return events after a date and time in ISO 8601 format.
|
73
77
|
page_number: 1, # Integer | Current page.
|
74
78
|
page_size: 20, # Integer | Number of records per page.
|
75
79
|
sort: 'created_at', # String | The order in which to list the results by creation date.
|
@@ -94,6 +98,10 @@ end
|
|
94
98
|
| **filter_user_id** | **String** | Limit the results returned to a specific user. | [optional] |
|
95
99
|
| **filter_token_id** | **String** | Limit the returned events to a specific token. | [optional] |
|
96
100
|
| **filter_created_at** | **String** | Limit the returned events to a specific time frame. Accepts sub-parameters: lt, lte, gt, gte (e.g., filter[created_at][gt]=2022-01-12). | [optional] |
|
101
|
+
| **filter_created_at_lte** | **String** | Return events on and before a date and time in ISO 8601 format. | [optional] |
|
102
|
+
| **filter_created_at_lt** | **String** | Return events before a date and time in ISO 8601 format. | [optional] |
|
103
|
+
| **filter_created_at_gte** | **String** | Return events on and after a date and time in ISO 8601 format. | [optional] |
|
104
|
+
| **filter_created_at_gt** | **String** | Return events after a date and time in ISO 8601 format. | [optional] |
|
97
105
|
| **page_number** | **Integer** | Current page. | [optional] |
|
98
106
|
| **page_size** | **Integer** | Number of records per page. | [optional][default to 20] |
|
99
107
|
| **sort** | **String** | The order in which to list the results by creation date. | [optional][default to 'created_at'] |
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# Fastly::LoggingNewrelicotlpAdditional
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **format** | **String** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional][default to '{\"timestamp\":\"%{begin:%Y-%m-%dT%H:%M:%S}t\",\"time_elapsed\":\"%{time.elapsed.usec}V\",\"is_tls\":\"%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V\",\"client_ip\":\"%{req.http.Fastly-Client-IP}V\",\"geo_city\":\"%{client.geo.city}V\",\"geo_country_code\":\"%{client.geo.country_code}V\",\"request\":\"%{req.request}V\",\"host\":\"%{req.http.Fastly-Orig-Host}V\",\"url\":\"%{json.escape(req.url)}V\",\"request_referer\":\"%{json.escape(req.http.Referer)}V\",\"request_user_agent\":\"%{json.escape(req.http.User-Agent)}V\",\"request_accept_language\":\"%{json.escape(req.http.Accept-Language)}V\",\"request_accept_charset\":\"%{json.escape(req.http.Accept-Charset)}V\",\"cache_status\":\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\"}'] |
|
8
|
+
| **token** | **String** | The Insert API key from the Account page of your New Relic account. Required. | [optional] |
|
9
|
+
| **region** | **String** | The region to which to stream logs. | [optional][default to 'US'] |
|
10
|
+
| **url** | **String** | (Optional) URL of the New Relic Trace Observer, if you are using New Relic Infinite Tracing. | [optional][default to 'null'] |
|
11
|
+
|
12
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
13
|
+
|
@@ -0,0 +1,252 @@
|
|
1
|
+
# Fastly::LoggingNewrelicotlpApi
|
2
|
+
|
3
|
+
|
4
|
+
```ruby
|
5
|
+
require 'fastly'
|
6
|
+
api_instance = Fastly::LoggingNewrelicotlpApi.new
|
7
|
+
```
|
8
|
+
|
9
|
+
## Methods
|
10
|
+
|
11
|
+
| Method | HTTP request | Description |
|
12
|
+
| ------ | ------------ | ----------- |
|
13
|
+
| [**create_log_newrelicotlp**](LoggingNewrelicotlpApi.md#create_log_newrelicotlp) | **POST** /service/{service_id}/version/{version_id}/logging/newrelicotlp | Create a New Relic OTLP endpoint |
|
14
|
+
| [**delete_log_newrelicotlp**](LoggingNewrelicotlpApi.md#delete_log_newrelicotlp) | **DELETE** /service/{service_id}/version/{version_id}/logging/newrelicotlp/{logging_newrelicotlp_name} | Delete a New Relic OTLP endpoint |
|
15
|
+
| [**get_log_newrelicotlp**](LoggingNewrelicotlpApi.md#get_log_newrelicotlp) | **GET** /service/{service_id}/version/{version_id}/logging/newrelicotlp/{logging_newrelicotlp_name} | Get a New Relic OTLP endpoint |
|
16
|
+
| [**list_log_newrelicotlp**](LoggingNewrelicotlpApi.md#list_log_newrelicotlp) | **GET** /service/{service_id}/version/{version_id}/logging/newrelicotlp | List New Relic OTLP endpoints |
|
17
|
+
| [**update_log_newrelicotlp**](LoggingNewrelicotlpApi.md#update_log_newrelicotlp) | **PUT** /service/{service_id}/version/{version_id}/logging/newrelicotlp/{logging_newrelicotlp_name} | Update a New Relic log endpoint |
|
18
|
+
|
19
|
+
|
20
|
+
## `create_log_newrelicotlp()`
|
21
|
+
|
22
|
+
```ruby
|
23
|
+
create_log_newrelicotlp(opts): <LoggingNewrelicotlpResponse> # Create a New Relic OTLP endpoint
|
24
|
+
```
|
25
|
+
|
26
|
+
Create a New Relic OTLP logging object for a particular service and version.
|
27
|
+
|
28
|
+
### Examples
|
29
|
+
|
30
|
+
```ruby
|
31
|
+
api_instance = Fastly::LoggingNewrelicotlpApi.new
|
32
|
+
opts = {
|
33
|
+
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
34
|
+
version_id: 56, # Integer | Integer identifying a service version.
|
35
|
+
name: 'name_example', # String | The name for the real-time logging configuration.
|
36
|
+
placement: 'none', # String | Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`.
|
37
|
+
response_condition: 'response_condition_example', # String | The name of an existing condition in the configured endpoint, or leave blank to always execute.
|
38
|
+
format: 'format_example', # String | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).
|
39
|
+
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
|
40
|
+
token: 'token_example', # String | The Insert API key from the Account page of your New Relic account. Required.
|
41
|
+
region: 'US', # String | The region to which to stream logs.
|
42
|
+
url: 'url_example', # String | (Optional) URL of the New Relic Trace Observer, if you are using New Relic Infinite Tracing.
|
43
|
+
}
|
44
|
+
|
45
|
+
begin
|
46
|
+
# Create a New Relic OTLP endpoint
|
47
|
+
result = api_instance.create_log_newrelicotlp(opts)
|
48
|
+
p result
|
49
|
+
rescue Fastly::ApiError => e
|
50
|
+
puts "Error when calling LoggingNewrelicotlpApi->create_log_newrelicotlp: #{e}"
|
51
|
+
end
|
52
|
+
```
|
53
|
+
|
54
|
+
### Options
|
55
|
+
|
56
|
+
| Name | Type | Description | Notes |
|
57
|
+
| ---- | ---- | ----------- | ----- |
|
58
|
+
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
59
|
+
| **version_id** | **Integer** | Integer identifying a service version. | |
|
60
|
+
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
61
|
+
| **placement** | **String** | Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`. | [optional] |
|
62
|
+
| **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
|
63
|
+
| **format** | **String** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional][default to '{\"timestamp\":\"%{begin:%Y-%m-%dT%H:%M:%S}t\",\"time_elapsed\":\"%{time.elapsed.usec}V\",\"is_tls\":\"%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V\",\"client_ip\":\"%{req.http.Fastly-Client-IP}V\",\"geo_city\":\"%{client.geo.city}V\",\"geo_country_code\":\"%{client.geo.country_code}V\",\"request\":\"%{req.request}V\",\"host\":\"%{req.http.Fastly-Orig-Host}V\",\"url\":\"%{json.escape(req.url)}V\",\"request_referer\":\"%{json.escape(req.http.Referer)}V\",\"request_user_agent\":\"%{json.escape(req.http.User-Agent)}V\",\"request_accept_language\":\"%{json.escape(req.http.Accept-Language)}V\",\"request_accept_charset\":\"%{json.escape(req.http.Accept-Charset)}V\",\"cache_status\":\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\"}'] |
|
64
|
+
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
|
65
|
+
| **token** | **String** | The Insert API key from the Account page of your New Relic account. Required. | [optional] |
|
66
|
+
| **region** | **String** | The region to which to stream logs. | [optional][default to 'US'] |
|
67
|
+
| **url** | **String** | (Optional) URL of the New Relic Trace Observer, if you are using New Relic Infinite Tracing. | [optional][default to 'null'] |
|
68
|
+
|
69
|
+
### Return type
|
70
|
+
|
71
|
+
[**LoggingNewrelicotlpResponse**](LoggingNewrelicotlpResponse.md)
|
72
|
+
|
73
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
74
|
+
[[Back to README]](../../README.md)
|
75
|
+
## `delete_log_newrelicotlp()`
|
76
|
+
|
77
|
+
```ruby
|
78
|
+
delete_log_newrelicotlp(opts): <InlineResponse200> # Delete a New Relic OTLP endpoint
|
79
|
+
```
|
80
|
+
|
81
|
+
Delete the New Relic OTLP logging object for a particular service and version.
|
82
|
+
|
83
|
+
### Examples
|
84
|
+
|
85
|
+
```ruby
|
86
|
+
api_instance = Fastly::LoggingNewrelicotlpApi.new
|
87
|
+
opts = {
|
88
|
+
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
89
|
+
version_id: 56, # Integer | Integer identifying a service version.
|
90
|
+
logging_newrelicotlp_name: 'logging_newrelicotlp_name_example', # String | The name for the real-time logging configuration.
|
91
|
+
}
|
92
|
+
|
93
|
+
begin
|
94
|
+
# Delete a New Relic OTLP endpoint
|
95
|
+
result = api_instance.delete_log_newrelicotlp(opts)
|
96
|
+
p result
|
97
|
+
rescue Fastly::ApiError => e
|
98
|
+
puts "Error when calling LoggingNewrelicotlpApi->delete_log_newrelicotlp: #{e}"
|
99
|
+
end
|
100
|
+
```
|
101
|
+
|
102
|
+
### Options
|
103
|
+
|
104
|
+
| Name | Type | Description | Notes |
|
105
|
+
| ---- | ---- | ----------- | ----- |
|
106
|
+
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
107
|
+
| **version_id** | **Integer** | Integer identifying a service version. | |
|
108
|
+
| **logging_newrelicotlp_name** | **String** | The name for the real-time logging configuration. | |
|
109
|
+
|
110
|
+
### Return type
|
111
|
+
|
112
|
+
[**InlineResponse200**](InlineResponse200.md)
|
113
|
+
|
114
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
115
|
+
[[Back to README]](../../README.md)
|
116
|
+
## `get_log_newrelicotlp()`
|
117
|
+
|
118
|
+
```ruby
|
119
|
+
get_log_newrelicotlp(opts): <LoggingNewrelicotlpResponse> # Get a New Relic OTLP endpoint
|
120
|
+
```
|
121
|
+
|
122
|
+
Get the details of a New Relic OTLP logging object for a particular service and version.
|
123
|
+
|
124
|
+
### Examples
|
125
|
+
|
126
|
+
```ruby
|
127
|
+
api_instance = Fastly::LoggingNewrelicotlpApi.new
|
128
|
+
opts = {
|
129
|
+
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
130
|
+
version_id: 56, # Integer | Integer identifying a service version.
|
131
|
+
logging_newrelicotlp_name: 'logging_newrelicotlp_name_example', # String | The name for the real-time logging configuration.
|
132
|
+
}
|
133
|
+
|
134
|
+
begin
|
135
|
+
# Get a New Relic OTLP endpoint
|
136
|
+
result = api_instance.get_log_newrelicotlp(opts)
|
137
|
+
p result
|
138
|
+
rescue Fastly::ApiError => e
|
139
|
+
puts "Error when calling LoggingNewrelicotlpApi->get_log_newrelicotlp: #{e}"
|
140
|
+
end
|
141
|
+
```
|
142
|
+
|
143
|
+
### Options
|
144
|
+
|
145
|
+
| Name | Type | Description | Notes |
|
146
|
+
| ---- | ---- | ----------- | ----- |
|
147
|
+
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
148
|
+
| **version_id** | **Integer** | Integer identifying a service version. | |
|
149
|
+
| **logging_newrelicotlp_name** | **String** | The name for the real-time logging configuration. | |
|
150
|
+
|
151
|
+
### Return type
|
152
|
+
|
153
|
+
[**LoggingNewrelicotlpResponse**](LoggingNewrelicotlpResponse.md)
|
154
|
+
|
155
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
156
|
+
[[Back to README]](../../README.md)
|
157
|
+
## `list_log_newrelicotlp()`
|
158
|
+
|
159
|
+
```ruby
|
160
|
+
list_log_newrelicotlp(opts): <Array<LoggingNewrelicotlpResponse>> # List New Relic OTLP endpoints
|
161
|
+
```
|
162
|
+
|
163
|
+
List all of the New Relic OTLP logging objects for a particular service and version.
|
164
|
+
|
165
|
+
### Examples
|
166
|
+
|
167
|
+
```ruby
|
168
|
+
api_instance = Fastly::LoggingNewrelicotlpApi.new
|
169
|
+
opts = {
|
170
|
+
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
171
|
+
version_id: 56, # Integer | Integer identifying a service version.
|
172
|
+
}
|
173
|
+
|
174
|
+
begin
|
175
|
+
# List New Relic OTLP endpoints
|
176
|
+
result = api_instance.list_log_newrelicotlp(opts)
|
177
|
+
p result
|
178
|
+
rescue Fastly::ApiError => e
|
179
|
+
puts "Error when calling LoggingNewrelicotlpApi->list_log_newrelicotlp: #{e}"
|
180
|
+
end
|
181
|
+
```
|
182
|
+
|
183
|
+
### Options
|
184
|
+
|
185
|
+
| Name | Type | Description | Notes |
|
186
|
+
| ---- | ---- | ----------- | ----- |
|
187
|
+
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
188
|
+
| **version_id** | **Integer** | Integer identifying a service version. | |
|
189
|
+
|
190
|
+
### Return type
|
191
|
+
|
192
|
+
[**Array<LoggingNewrelicotlpResponse>**](LoggingNewrelicotlpResponse.md)
|
193
|
+
|
194
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
195
|
+
[[Back to README]](../../README.md)
|
196
|
+
## `update_log_newrelicotlp()`
|
197
|
+
|
198
|
+
```ruby
|
199
|
+
update_log_newrelicotlp(opts): <LoggingNewrelicotlpResponse> # Update a New Relic log endpoint
|
200
|
+
```
|
201
|
+
|
202
|
+
Update a New Relic OTLP logging object for a particular service and version.
|
203
|
+
|
204
|
+
### Examples
|
205
|
+
|
206
|
+
```ruby
|
207
|
+
api_instance = Fastly::LoggingNewrelicotlpApi.new
|
208
|
+
opts = {
|
209
|
+
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
210
|
+
version_id: 56, # Integer | Integer identifying a service version.
|
211
|
+
logging_newrelicotlp_name: 'logging_newrelicotlp_name_example', # String | The name for the real-time logging configuration.
|
212
|
+
name: 'name_example', # String | The name for the real-time logging configuration.
|
213
|
+
placement: 'none', # String | Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`.
|
214
|
+
response_condition: 'response_condition_example', # String | The name of an existing condition in the configured endpoint, or leave blank to always execute.
|
215
|
+
format: 'format_example', # String | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats).
|
216
|
+
format_version: 1, # Integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`.
|
217
|
+
token: 'token_example', # String | The Insert API key from the Account page of your New Relic account. Required.
|
218
|
+
region: 'US', # String | The region to which to stream logs.
|
219
|
+
url: 'url_example', # String | (Optional) URL of the New Relic Trace Observer, if you are using New Relic Infinite Tracing.
|
220
|
+
}
|
221
|
+
|
222
|
+
begin
|
223
|
+
# Update a New Relic log endpoint
|
224
|
+
result = api_instance.update_log_newrelicotlp(opts)
|
225
|
+
p result
|
226
|
+
rescue Fastly::ApiError => e
|
227
|
+
puts "Error when calling LoggingNewrelicotlpApi->update_log_newrelicotlp: #{e}"
|
228
|
+
end
|
229
|
+
```
|
230
|
+
|
231
|
+
### Options
|
232
|
+
|
233
|
+
| Name | Type | Description | Notes |
|
234
|
+
| ---- | ---- | ----------- | ----- |
|
235
|
+
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
236
|
+
| **version_id** | **Integer** | Integer identifying a service version. | |
|
237
|
+
| **logging_newrelicotlp_name** | **String** | The name for the real-time logging configuration. | |
|
238
|
+
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
239
|
+
| **placement** | **String** | Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`. | [optional] |
|
240
|
+
| **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
|
241
|
+
| **format** | **String** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional][default to '{\"timestamp\":\"%{begin:%Y-%m-%dT%H:%M:%S}t\",\"time_elapsed\":\"%{time.elapsed.usec}V\",\"is_tls\":\"%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V\",\"client_ip\":\"%{req.http.Fastly-Client-IP}V\",\"geo_city\":\"%{client.geo.city}V\",\"geo_country_code\":\"%{client.geo.country_code}V\",\"request\":\"%{req.request}V\",\"host\":\"%{req.http.Fastly-Orig-Host}V\",\"url\":\"%{json.escape(req.url)}V\",\"request_referer\":\"%{json.escape(req.http.Referer)}V\",\"request_user_agent\":\"%{json.escape(req.http.User-Agent)}V\",\"request_accept_language\":\"%{json.escape(req.http.Accept-Language)}V\",\"request_accept_charset\":\"%{json.escape(req.http.Accept-Charset)}V\",\"cache_status\":\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\"}'] |
|
242
|
+
| **format_version** | **Integer** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to FORMAT_VERSION::v2] |
|
243
|
+
| **token** | **String** | The Insert API key from the Account page of your New Relic account. Required. | [optional] |
|
244
|
+
| **region** | **String** | The region to which to stream logs. | [optional][default to 'US'] |
|
245
|
+
| **url** | **String** | (Optional) URL of the New Relic Trace Observer, if you are using New Relic Infinite Tracing. | [optional][default to 'null'] |
|
246
|
+
|
247
|
+
### Return type
|
248
|
+
|
249
|
+
[**LoggingNewrelicotlpResponse**](LoggingNewrelicotlpResponse.md)
|
250
|
+
|
251
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
252
|
+
[[Back to README]](../../README.md)
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# Fastly::LoggingNewrelicotlpResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **name** | **String** | The name for the real-time logging configuration. | [optional] |
|
8
|
+
| **placement** | **String** | Where in the generated VCL the logging call should be placed. If not set, endpoints with `format_version` of 2 are placed in `vcl_log` and those with `format_version` of 1 are placed in `vcl_deliver`. | [optional] |
|
9
|
+
| **response_condition** | **String** | The name of an existing condition in the configured endpoint, or leave blank to always execute. | [optional] |
|
10
|
+
| **format** | **String** | A Fastly [log format string](https://docs.fastly.com/en/guides/custom-log-formats). | [optional][default to '{\"timestamp\":\"%{begin:%Y-%m-%dT%H:%M:%S}t\",\"time_elapsed\":\"%{time.elapsed.usec}V\",\"is_tls\":\"%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V\",\"client_ip\":\"%{req.http.Fastly-Client-IP}V\",\"geo_city\":\"%{client.geo.city}V\",\"geo_country_code\":\"%{client.geo.country_code}V\",\"request\":\"%{req.request}V\",\"host\":\"%{req.http.Fastly-Orig-Host}V\",\"url\":\"%{json.escape(req.url)}V\",\"request_referer\":\"%{json.escape(req.http.Referer)}V\",\"request_user_agent\":\"%{json.escape(req.http.User-Agent)}V\",\"request_accept_language\":\"%{json.escape(req.http.Accept-Language)}V\",\"request_accept_charset\":\"%{json.escape(req.http.Accept-Charset)}V\",\"cache_status\":\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\"}'] |
|
11
|
+
| **format_version** | **String** | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in `vcl_log` if `format_version` is set to `2` and in `vcl_deliver` if `format_version` is set to `1`. | [optional][default to '2'] |
|
12
|
+
| **token** | **String** | The Insert API key from the Account page of your New Relic account. Required. | [optional] |
|
13
|
+
| **region** | **String** | The region to which to stream logs. | [optional][default to 'US'] |
|
14
|
+
| **url** | **String** | (Optional) URL of the New Relic Trace Observer, if you are using New Relic Infinite Tracing. | [optional][default to 'null'] |
|
15
|
+
| **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
16
|
+
| **deleted_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
17
|
+
| **updated_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
18
|
+
| **service_id** | **String** | | [optional][readonly] |
|
19
|
+
| **version** | **String** | | [optional][readonly] |
|
20
|
+
|
21
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
22
|
+
|
data/docs/SecretStoreApi.md
CHANGED
@@ -13,7 +13,7 @@ api_instance = Fastly::SecretStoreApi.new
|
|
13
13
|
| [**client_key**](SecretStoreApi.md#client_key) | **POST** /resources/stores/secret/client-key | Create new client key |
|
14
14
|
| [**create_secret_store**](SecretStoreApi.md#create_secret_store) | **POST** /resources/stores/secret | Create new secret store |
|
15
15
|
| [**delete_secret_store**](SecretStoreApi.md#delete_secret_store) | **DELETE** /resources/stores/secret/{store_id} | Delete secret store |
|
16
|
-
| [**get_secret_store**](SecretStoreApi.md#get_secret_store) | **GET** /resources/stores/secret/{store_id} |
|
16
|
+
| [**get_secret_store**](SecretStoreApi.md#get_secret_store) | **GET** /resources/stores/secret/{store_id} | Get secret store by ID |
|
17
17
|
| [**get_secret_stores**](SecretStoreApi.md#get_secret_stores) | **GET** /resources/stores/secret | Get all secret stores |
|
18
18
|
| [**signing_key**](SecretStoreApi.md#signing_key) | **GET** /resources/stores/secret/signing-key | Get public key |
|
19
19
|
|
@@ -126,7 +126,7 @@ nil (empty response body)
|
|
126
126
|
## `get_secret_store()`
|
127
127
|
|
128
128
|
```ruby
|
129
|
-
get_secret_store(opts): <SecretStoreResponse> #
|
129
|
+
get_secret_store(opts): <SecretStoreResponse> # Get secret store by ID
|
130
130
|
```
|
131
131
|
|
132
132
|
Get a secret store by ID.
|
@@ -140,7 +140,7 @@ opts = {
|
|
140
140
|
}
|
141
141
|
|
142
142
|
begin
|
143
|
-
#
|
143
|
+
# Get secret store by ID
|
144
144
|
result = api_instance.get_secret_store(opts)
|
145
145
|
p result
|
146
146
|
rescue Fastly::ApiError => e
|
data/docs/TlsDomainsApi.md
CHANGED
@@ -29,7 +29,7 @@ opts = {
|
|
29
29
|
filter_in_use: 'filter_in_use_example', # String | Optional. Limit the returned domains to those currently using Fastly to terminate TLS with SNI (that is, domains considered \"in use\") Permitted values: true, false.
|
30
30
|
filter_tls_certificates_id: 'filter_tls_certificates_id_example', # String | Optional. Limit the returned domains to those listed in the given TLS certificate's SAN list.
|
31
31
|
filter_tls_subscriptions_id: 'filter_tls_subscriptions_id_example', # String | Optional. Limit the returned domains to those for a given TLS subscription.
|
32
|
-
include: 'include_example', # String | Include related objects. Optional, comma-separated values. Permitted values: `tls_activations`, `tls_certificates`, `tls_subscriptions`, `tls_subscriptions.tls_authorizations`, and `tls_authorizations.
|
32
|
+
include: 'include_example', # String | Include related objects. Optional, comma-separated values. Permitted values: `tls_activations`, `tls_certificates`, `tls_subscriptions`, `tls_subscriptions.tls_authorizations`, `tls_authorizations.globalsign_email_challenge`, and `tls_authorizations.self_managed_http_challenge`.
|
33
33
|
page_number: 1, # Integer | Current page.
|
34
34
|
page_size: 20, # Integer | Number of records per page.
|
35
35
|
sort: 'created_at', # String | The order in which to list the results by creation date.
|
@@ -51,7 +51,7 @@ end
|
|
51
51
|
| **filter_in_use** | **String** | Optional. Limit the returned domains to those currently using Fastly to terminate TLS with SNI (that is, domains considered \"in use\") Permitted values: true, false. | [optional] |
|
52
52
|
| **filter_tls_certificates_id** | **String** | Optional. Limit the returned domains to those listed in the given TLS certificate's SAN list. | [optional] |
|
53
53
|
| **filter_tls_subscriptions_id** | **String** | Optional. Limit the returned domains to those for a given TLS subscription. | [optional] |
|
54
|
-
| **include** | **String** | Include related objects. Optional, comma-separated values. Permitted values: `tls_activations`, `tls_certificates`, `tls_subscriptions`, `tls_subscriptions.tls_authorizations`, and `tls_authorizations.
|
54
|
+
| **include** | **String** | Include related objects. Optional, comma-separated values. Permitted values: `tls_activations`, `tls_certificates`, `tls_subscriptions`, `tls_subscriptions.tls_authorizations`, `tls_authorizations.globalsign_email_challenge`, and `tls_authorizations.self_managed_http_challenge`. | [optional] |
|
55
55
|
| **page_number** | **Integer** | Current page. | [optional] |
|
56
56
|
| **page_size** | **Integer** | Number of records per page. | [optional][default to 20] |
|
57
57
|
| **sort** | **String** | The order in which to list the results by creation date. | [optional][default to 'created_at'] |
|
data/docs/TlsSubscriptionsApi.md
CHANGED
@@ -189,7 +189,7 @@ Show a TLS subscription.
|
|
189
189
|
api_instance = Fastly::TlsSubscriptionsApi.new
|
190
190
|
opts = {
|
191
191
|
tls_subscription_id: 'tls_subscription_id_example', # String | Alphanumeric string identifying a TLS subscription.
|
192
|
-
include: 'tls_authorizations', # String | Include related objects. Optional, comma-separated values. Permitted values: `tls_authorizations` and `tls_authorizations.
|
192
|
+
include: 'tls_authorizations', # String | Include related objects. Optional, comma-separated values. Permitted values: `tls_authorizations`, `tls_authorizations.globalsign_email_challenge`, and `tls_authorizations.self_managed_http_challenge`.
|
193
193
|
}
|
194
194
|
|
195
195
|
begin
|
@@ -205,7 +205,7 @@ end
|
|
205
205
|
|
206
206
|
| Name | Type | Description | Notes |
|
207
207
|
| ---- | ---- | ----------- | ----- |
|
208
|
-
| **include** | **String** | Include related objects. Optional, comma-separated values. Permitted values: `tls_authorizations` and `tls_authorizations.
|
208
|
+
| **include** | **String** | Include related objects. Optional, comma-separated values. Permitted values: `tls_authorizations`, `tls_authorizations.globalsign_email_challenge`, and `tls_authorizations.self_managed_http_challenge`. | [optional] |
|
209
209
|
| **tls_subscription_id** | **String** | Alphanumeric string identifying a TLS subscription. | |
|
210
210
|
|
211
211
|
### Return type
|
@@ -230,7 +230,7 @@ opts = {
|
|
230
230
|
filter_state: 'filter_state_example', # String | Limit the returned subscriptions by state. Valid values are `pending`, `processing`, `issued`, `renewing`, and `failed`. Accepts parameters: `not` (e.g., `filter[state][not]=renewing`).
|
231
231
|
filter_tls_domains_id: 'filter_tls_domains_id_example', # String | Limit the returned subscriptions to those that include the specific domain.
|
232
232
|
filter_has_active_order: true, # Boolean | Limit the returned subscriptions to those that have currently active orders. Permitted values: `true`.
|
233
|
-
include: 'tls_authorizations', # String | Include related objects. Optional, comma-separated values. Permitted values: `tls_authorizations` and `tls_authorizations.
|
233
|
+
include: 'tls_authorizations', # String | Include related objects. Optional, comma-separated values. Permitted values: `tls_authorizations`, `tls_authorizations.globalsign_email_challenge`, and `tls_authorizations.self_managed_http_challenge`.
|
234
234
|
page_number: 1, # Integer | Current page.
|
235
235
|
page_size: 20, # Integer | Number of records per page.
|
236
236
|
sort: 'created_at', # String | The order in which to list the results by creation date.
|
@@ -252,7 +252,7 @@ end
|
|
252
252
|
| **filter_state** | **String** | Limit the returned subscriptions by state. Valid values are `pending`, `processing`, `issued`, `renewing`, and `failed`. Accepts parameters: `not` (e.g., `filter[state][not]=renewing`). | [optional] |
|
253
253
|
| **filter_tls_domains_id** | **String** | Limit the returned subscriptions to those that include the specific domain. | [optional] |
|
254
254
|
| **filter_has_active_order** | **Boolean** | Limit the returned subscriptions to those that have currently active orders. Permitted values: `true`. | [optional] |
|
255
|
-
| **include** | **String** | Include related objects. Optional, comma-separated values. Permitted values: `tls_authorizations` and `tls_authorizations.
|
255
|
+
| **include** | **String** | Include related objects. Optional, comma-separated values. Permitted values: `tls_authorizations`, `tls_authorizations.globalsign_email_challenge`, and `tls_authorizations.self_managed_http_challenge`. | [optional] |
|
256
256
|
| **page_number** | **Integer** | Current page. | [optional] |
|
257
257
|
| **page_size** | **Integer** | Number of records per page. | [optional][default to 20] |
|
258
258
|
| **sort** | **String** | The order in which to list the results by creation date. | [optional][default to 'created_at'] |
|
@@ -40,6 +40,7 @@ module Fastly
|
|
40
40
|
# @option opts [String] :override_host If set, will replace the client-supplied HTTP `Host` header on connections to this backend. Applied after VCL has been processed, so this setting will take precedence over changing `bereq.http.Host` in VCL.
|
41
41
|
# @option opts [Integer] :port Port on which the backend server is listening for connections from Fastly. Setting `port` to 80 or 443 will also set `use_ssl` automatically (to false and true respectively), unless explicitly overridden by setting `use_ssl` in the same request.
|
42
42
|
# @option opts [String] :request_condition Name of a Condition, which if satisfied, will select this backend during a request. If set, will override any `auto_loadbalance` setting. By default, the first backend added to a service is selected for all requests.
|
43
|
+
# @option opts [String] :share_key Value that when shared across backends will enable those backends to share the same health check.
|
43
44
|
# @option opts [String] :shield Identifier of the POP to use as a [shield](https://docs.fastly.com/en/guides/shielding).
|
44
45
|
# @option opts [String] :ssl_ca_cert CA certificate attached to origin.
|
45
46
|
# @option opts [String] :ssl_cert_hostname Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.
|
@@ -80,6 +81,7 @@ module Fastly
|
|
80
81
|
# @option opts [String] :override_host If set, will replace the client-supplied HTTP `Host` header on connections to this backend. Applied after VCL has been processed, so this setting will take precedence over changing `bereq.http.Host` in VCL.
|
81
82
|
# @option opts [Integer] :port Port on which the backend server is listening for connections from Fastly. Setting `port` to 80 or 443 will also set `use_ssl` automatically (to false and true respectively), unless explicitly overridden by setting `use_ssl` in the same request.
|
82
83
|
# @option opts [String] :request_condition Name of a Condition, which if satisfied, will select this backend during a request. If set, will override any `auto_loadbalance` setting. By default, the first backend added to a service is selected for all requests.
|
84
|
+
# @option opts [String] :share_key Value that when shared across backends will enable those backends to share the same health check.
|
83
85
|
# @option opts [String] :shield Identifier of the POP to use as a [shield](https://docs.fastly.com/en/guides/shielding).
|
84
86
|
# @option opts [String] :ssl_ca_cert CA certificate attached to origin.
|
85
87
|
# @option opts [String] :ssl_cert_hostname Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.
|
@@ -107,6 +109,11 @@ module Fastly
|
|
107
109
|
if @api_client.config.client_side_validation && version_id.nil?
|
108
110
|
fail ArgumentError, "Missing the required parameter 'version_id' when calling BackendApi.create_backend"
|
109
111
|
end
|
112
|
+
pattern = Regexp.new(/^[A-Za-z0-9]+$/)
|
113
|
+
if @api_client.config.client_side_validation && !opts[:'share_key'].nil? && opts[:'share_key'] !~ pattern
|
114
|
+
fail ArgumentError, "invalid value for 'opts[:\"share_key\"]' when calling BackendApi.create_backend, must conform to the pattern #{pattern}."
|
115
|
+
end
|
116
|
+
|
110
117
|
# resource path
|
111
118
|
local_var_path = '/service/{service_id}/version/{version_id}/backend'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s))
|
112
119
|
|
@@ -144,6 +151,7 @@ module Fastly
|
|
144
151
|
form_params['override_host'] = opts[:'override_host'] if !opts[:'override_host'].nil?
|
145
152
|
form_params['port'] = opts[:'port'] if !opts[:'port'].nil?
|
146
153
|
form_params['request_condition'] = opts[:'request_condition'] if !opts[:'request_condition'].nil?
|
154
|
+
form_params['share_key'] = opts[:'share_key'] if !opts[:'share_key'].nil?
|
147
155
|
form_params['shield'] = opts[:'shield'] if !opts[:'shield'].nil?
|
148
156
|
form_params['ssl_ca_cert'] = opts[:'ssl_ca_cert'] if !opts[:'ssl_ca_cert'].nil?
|
149
157
|
form_params['ssl_cert_hostname'] = opts[:'ssl_cert_hostname'] if !opts[:'ssl_cert_hostname'].nil?
|
@@ -430,6 +438,7 @@ module Fastly
|
|
430
438
|
# @option opts [String] :override_host If set, will replace the client-supplied HTTP `Host` header on connections to this backend. Applied after VCL has been processed, so this setting will take precedence over changing `bereq.http.Host` in VCL.
|
431
439
|
# @option opts [Integer] :port Port on which the backend server is listening for connections from Fastly. Setting `port` to 80 or 443 will also set `use_ssl` automatically (to false and true respectively), unless explicitly overridden by setting `use_ssl` in the same request.
|
432
440
|
# @option opts [String] :request_condition Name of a Condition, which if satisfied, will select this backend during a request. If set, will override any `auto_loadbalance` setting. By default, the first backend added to a service is selected for all requests.
|
441
|
+
# @option opts [String] :share_key Value that when shared across backends will enable those backends to share the same health check.
|
433
442
|
# @option opts [String] :shield Identifier of the POP to use as a [shield](https://docs.fastly.com/en/guides/shielding).
|
434
443
|
# @option opts [String] :ssl_ca_cert CA certificate attached to origin.
|
435
444
|
# @option opts [String] :ssl_cert_hostname Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.
|
@@ -471,6 +480,7 @@ module Fastly
|
|
471
480
|
# @option opts [String] :override_host If set, will replace the client-supplied HTTP `Host` header on connections to this backend. Applied after VCL has been processed, so this setting will take precedence over changing `bereq.http.Host` in VCL.
|
472
481
|
# @option opts [Integer] :port Port on which the backend server is listening for connections from Fastly. Setting `port` to 80 or 443 will also set `use_ssl` automatically (to false and true respectively), unless explicitly overridden by setting `use_ssl` in the same request.
|
473
482
|
# @option opts [String] :request_condition Name of a Condition, which if satisfied, will select this backend during a request. If set, will override any `auto_loadbalance` setting. By default, the first backend added to a service is selected for all requests.
|
483
|
+
# @option opts [String] :share_key Value that when shared across backends will enable those backends to share the same health check.
|
474
484
|
# @option opts [String] :shield Identifier of the POP to use as a [shield](https://docs.fastly.com/en/guides/shielding).
|
475
485
|
# @option opts [String] :ssl_ca_cert CA certificate attached to origin.
|
476
486
|
# @option opts [String] :ssl_cert_hostname Overrides `ssl_hostname`, but only for cert verification. Does not affect SNI at all.
|
@@ -503,6 +513,11 @@ module Fastly
|
|
503
513
|
if @api_client.config.client_side_validation && backend_name.nil?
|
504
514
|
fail ArgumentError, "Missing the required parameter 'backend_name' when calling BackendApi.update_backend"
|
505
515
|
end
|
516
|
+
pattern = Regexp.new(/^[A-Za-z0-9]+$/)
|
517
|
+
if @api_client.config.client_side_validation && !opts[:'share_key'].nil? && opts[:'share_key'] !~ pattern
|
518
|
+
fail ArgumentError, "invalid value for 'opts[:\"share_key\"]' when calling BackendApi.update_backend, must conform to the pattern #{pattern}."
|
519
|
+
end
|
520
|
+
|
506
521
|
# resource path
|
507
522
|
local_var_path = '/service/{service_id}/version/{version_id}/backend/{backend_name}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'version_id' + '}', CGI.escape(version_id.to_s)).sub('{' + 'backend_name' + '}', CGI.escape(backend_name.to_s))
|
508
523
|
|
@@ -540,6 +555,7 @@ module Fastly
|
|
540
555
|
form_params['override_host'] = opts[:'override_host'] if !opts[:'override_host'].nil?
|
541
556
|
form_params['port'] = opts[:'port'] if !opts[:'port'].nil?
|
542
557
|
form_params['request_condition'] = opts[:'request_condition'] if !opts[:'request_condition'].nil?
|
558
|
+
form_params['share_key'] = opts[:'share_key'] if !opts[:'share_key'].nil?
|
543
559
|
form_params['shield'] = opts[:'shield'] if !opts[:'shield'].nil?
|
544
560
|
form_params['ssl_ca_cert'] = opts[:'ssl_ca_cert'] if !opts[:'ssl_ca_cert'].nil?
|
545
561
|
form_params['ssl_cert_hostname'] = opts[:'ssl_cert_hostname'] if !opts[:'ssl_cert_hostname'].nil?
|