fastly 5.3.1 → 6.0.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 +63 -0
- data/Gemfile.lock +1 -1
- data/README.md +85 -63
- data/docs/AclEntry.md +1 -1
- data/docs/AclEntryApi.md +176 -0
- data/docs/AclEntryResponse.md +1 -1
- data/docs/ApexRedirectApi.md +56 -0
- data/docs/{BillingEstimateResponseAllOfLines.md → BillingEstimateLines.md} +2 -2
- data/docs/{BillingEstimateResponseAllOfLine.md → BillingEstimateLinesLineItems.md} +1 -1
- data/docs/BillingEstimateResponse.md +1 -1
- data/docs/{BillingResponseAllOf.md → BillingResponseItemItemsData.md} +1 -1
- data/docs/BillingResponseLineItem.md +1 -1
- data/docs/BillingStatus.md +1 -1
- data/docs/BulkUpdateAclEntry.md +1 -1
- data/docs/ClientKey.md +12 -0
- data/docs/ContactApi.md +50 -0
- data/docs/Content.md +2 -2
- data/docs/ContentApi.md +52 -0
- data/docs/DirectorApi.md +42 -0
- data/docs/DomainInspector.md +12 -0
- data/docs/DomainInspectorEntry.md +11 -0
- data/docs/DomainInspectorEntryDimensions.md +12 -0
- data/docs/DomainInspectorHistoricalApi.md +72 -0
- data/docs/DomainInspectorMeasurements.md +71 -0
- data/docs/DomainInspectorRealtimeApi.md +132 -0
- data/docs/DomainInspectorRealtimeEntry.md +12 -0
- data/docs/EventAttributes.md +1 -1
- data/docs/{EventsResponseAllOf.md → EventData.md} +1 -1
- data/docs/HistoricalDomains.md +13 -0
- data/docs/HistoricalDomainsData.md +11 -0
- data/docs/HistoricalDomainsMeta.md +18 -0
- data/docs/HistoricalDomainsMetaFilters.md +12 -0
- data/docs/HistoricalDomainsResponse.md +13 -0
- data/docs/HistoricalDomainsResponseAllOf.md +10 -0
- data/docs/{HistoricalFieldResultsAttributesAllOf.md → HistoricalFieldResultsAttributesAdditional.md} +1 -1
- data/docs/HistoricalOriginsResponse.md +13 -0
- data/docs/HistoricalOriginsResponseAllOf.md +10 -0
- data/docs/IamRolesApi.md +157 -0
- data/docs/IamServiceGroupsApi.md +157 -0
- data/docs/IamUserGroupsApi.md +315 -0
- data/docs/InlineResponse2005.md +11 -0
- data/docs/InlineResponse2006.md +11 -0
- data/docs/{BillingEstimateResponseAllOf.md → InlineResponse2007.md} +2 -2
- data/docs/InlineResponse400.md +10 -0
- data/docs/LegacyWafConfigurationSet.md +11 -0
- data/docs/LegacyWafConfigurationSetsApi.md +125 -0
- data/docs/LegacyWafFirewall.md +18 -0
- data/docs/LegacyWafFirewallApi.md +352 -0
- data/docs/LegacyWafOwasp.md +38 -0
- data/docs/LegacyWafOwaspApi.md +138 -0
- data/docs/LegacyWafRule.md +14 -0
- data/docs/LegacyWafRuleApi.md +184 -0
- data/docs/LegacyWafRuleStatus.md +12 -0
- data/docs/LegacyWafRuleStatusApi.md +202 -0
- data/docs/LegacyWafRuleset.md +11 -0
- data/docs/LegacyWafRulesetApi.md +136 -0
- data/docs/LegacyWafTag.md +10 -0
- data/docs/LegacyWafTagApi.md +58 -0
- data/docs/LegacyWafUpdateStatus.md +15 -0
- data/docs/LegacyWafUpdateStatusApi.md +102 -0
- data/docs/{BillingResponseLineItemAllOf.md → LineItemData.md} +2 -2
- data/docs/LineItemDataReadOnlyInvoiceId.md +9 -0
- data/docs/LoggingKafkaApi.md +42 -0
- data/docs/LoggingKinesisApi.md +42 -0
- data/docs/OriginInspector.md +12 -0
- data/docs/OriginInspectorDimensions.md +12 -0
- data/docs/OriginInspectorEntry.md +11 -0
- data/docs/OriginInspectorHistorical.md +13 -0
- data/docs/OriginInspectorHistoricalApi.md +72 -0
- data/docs/OriginInspectorHistoricalData.md +11 -0
- data/docs/OriginInspectorHistoricalMeta.md +18 -0
- data/docs/OriginInspectorHistoricalMetaFilters.md +12 -0
- data/docs/OriginInspectorMeasurements.md +161 -0
- data/docs/OriginInspectorRealtimeApi.md +132 -0
- data/docs/OriginInspectorRealtimeEntry.md +12 -0
- data/docs/OriginInspectorRealtimeEntryRecorded.md +9 -0
- data/docs/OriginInspectorSubsequentRequestTimestamp.md +9 -0
- data/docs/OriginInspectorValues.md +161 -0
- data/docs/PaginationCursorMeta.md +11 -0
- data/docs/ReadOnlyServiceId.md +9 -0
- data/docs/ReadOnlyVersion.md +9 -0
- data/docs/RealtimeEntry.md +2 -2
- data/docs/RealtimeEntryAggregated.md +227 -0
- data/docs/RealtimeEntryRecorded.md +9 -0
- data/docs/RealtimeMeasurements.md +1 -1
- data/docs/RecordedTimestamp.md +9 -0
- data/docs/RequestSettingsApi.md +40 -0
- data/docs/ResponseObjectApi.md +82 -0
- data/docs/SchemasUserResponseReadOnly.md +12 -0
- data/docs/Secret.md +12 -0
- data/docs/SecretResponse.md +13 -0
- data/docs/SecretStore.md +10 -0
- data/docs/SecretStoreApi.md +233 -0
- data/docs/SecretStoreItemApi.md +255 -0
- data/docs/SecretStoreResponse.md +12 -0
- data/docs/ServiceAuthorizationsApi.md +76 -0
- data/docs/SigningKey.md +10 -0
- data/docs/SnippetApi.md +42 -0
- data/docs/SubsequentRequestTimestamp.md +9 -0
- data/docs/SudoApi.md +52 -0
- data/docs/SudoGenericTokenError.md +10 -0
- data/docs/SudoRequest.md +12 -0
- data/docs/SudoResponse.md +10 -0
- data/docs/TokensApi.md +70 -0
- data/docs/{UserResponseAllOf.md → UserResponseReadOnly.md} +1 -1
- data/docs/Values.md +71 -0
- data/docs/WafActiveRulesApi.md +41 -0
- data/lib/fastly/api/acl_entry_api.rb +332 -0
- data/lib/fastly/api/apex_redirect_api.rb +111 -0
- data/lib/fastly/api/contact_api.rb +90 -0
- data/lib/fastly/api/content_api.rb +79 -0
- data/lib/fastly/api/director_api.rb +82 -0
- data/lib/fastly/api/domain_inspector_historical_api.rb +125 -0
- data/lib/fastly/api/domain_inspector_realtime_api.rb +223 -0
- data/lib/fastly/api/iam_roles_api.rb +271 -0
- data/lib/fastly/api/iam_service_groups_api.rb +271 -0
- data/lib/fastly/api/iam_user_groups_api.rb +547 -0
- data/lib/fastly/api/legacy_waf_configuration_sets_api.rb +209 -0
- data/lib/fastly/api/legacy_waf_firewall_api.rb +627 -0
- data/lib/fastly/api/legacy_waf_owasp_api.rb +244 -0
- data/lib/fastly/api/legacy_waf_rule_api.rb +307 -0
- data/lib/fastly/api/legacy_waf_rule_status_api.rb +366 -0
- data/lib/fastly/api/legacy_waf_ruleset_api.rb +237 -0
- data/lib/fastly/api/legacy_waf_tag_api.rb +96 -0
- data/lib/fastly/api/legacy_waf_update_status_api.rb +184 -0
- data/lib/fastly/api/logging_kafka_api.rb +82 -0
- data/lib/fastly/api/logging_kinesis_api.rb +82 -0
- data/lib/fastly/api/origin_inspector_historical_api.rb +125 -0
- data/lib/fastly/api/origin_inspector_realtime_api.rb +223 -0
- data/lib/fastly/api/request_settings_api.rb +75 -0
- data/lib/fastly/api/response_object_api.rb +157 -0
- data/lib/fastly/api/secret_store_api.rb +381 -0
- data/lib/fastly/api/secret_store_item_api.rb +437 -0
- data/lib/fastly/api/service_authorizations_api.rb +126 -0
- data/lib/fastly/api/snippet_api.rb +82 -0
- data/lib/fastly/api/sudo_api.rb +83 -0
- data/lib/fastly/api/tokens_api.rb +122 -0
- data/lib/fastly/api/waf_active_rules_api.rb +75 -0
- data/lib/fastly/configuration.rb +504 -0
- data/lib/fastly/models/acl_entry.rb +1 -1
- data/lib/fastly/models/acl_entry_response.rb +1 -1
- data/lib/fastly/models/{billing_response_all_of.rb → billing_estimate_lines.rb} +4 -4
- data/lib/fastly/models/{billing_estimate_response_all_of_line.rb → billing_estimate_lines_line_items.rb} +3 -3
- data/lib/fastly/models/billing_estimate_response.rb +9 -9
- data/lib/fastly/models/billing_response.rb +1 -1
- data/lib/fastly/models/{billing_estimate_response_all_of.rb → billing_response_item_items_data.rb} +11 -11
- data/lib/fastly/models/billing_response_line_item.rb +2 -2
- data/lib/fastly/models/billing_status.rb +2 -0
- data/lib/fastly/models/bulk_update_acl_entry.rb +1 -1
- data/lib/fastly/models/client_key.rb +239 -0
- data/lib/fastly/models/content.rb +8 -4
- data/lib/fastly/models/domain.rb +1 -0
- data/lib/fastly/models/domain_inspector.rb +238 -0
- data/lib/fastly/models/domain_inspector_entry.rb +228 -0
- data/lib/fastly/models/domain_inspector_entry_dimensions.rb +238 -0
- data/lib/fastly/models/domain_inspector_measurements.rb +828 -0
- data/lib/fastly/models/domain_inspector_realtime_entry.rb +241 -0
- data/lib/fastly/models/event_attributes.rb +4 -2
- data/lib/fastly/models/{events_response_all_of.rb → event_data.rb} +3 -3
- data/lib/fastly/models/events_response.rb +1 -1
- data/lib/fastly/models/historical_domains.rb +249 -0
- data/lib/fastly/models/historical_domains_data.rb +228 -0
- data/lib/fastly/models/historical_domains_meta.rb +297 -0
- data/lib/fastly/models/historical_domains_meta_filters.rb +235 -0
- data/lib/fastly/models/historical_domains_response.rb +257 -0
- data/lib/fastly/models/historical_domains_response_all_of.rb +219 -0
- data/lib/fastly/models/historical_field_results_attributes.rb +1 -1
- data/lib/fastly/models/{historical_field_results_attributes_all_of.rb → historical_field_results_attributes_additional.rb} +3 -3
- data/lib/fastly/models/historical_origins_response.rb +257 -0
- data/lib/fastly/models/historical_origins_response_all_of.rb +219 -0
- data/lib/fastly/models/inline_response2005.rb +227 -0
- data/lib/fastly/models/inline_response2006.rb +227 -0
- data/lib/fastly/models/inline_response2007.rb +218 -0
- data/lib/fastly/models/inline_response400.rb +250 -0
- data/lib/fastly/models/legacy_waf_configuration_set.rb +227 -0
- data/lib/fastly/models/legacy_waf_firewall.rb +297 -0
- data/lib/fastly/models/legacy_waf_owasp.rb +527 -0
- data/lib/fastly/models/legacy_waf_rule.rb +257 -0
- data/lib/fastly/models/legacy_waf_rule_status.rb +237 -0
- data/lib/fastly/models/legacy_waf_ruleset.rb +227 -0
- data/lib/fastly/models/{billing_estimate_response_all_of_lines.rb → legacy_waf_tag.rb} +11 -10
- data/lib/fastly/models/legacy_waf_update_status.rb +267 -0
- data/lib/fastly/models/{billing_response_line_item_all_of.rb → line_item_data.rb} +4 -4
- data/lib/fastly/models/line_item_data_read_only_invoice_id.rb +207 -0
- data/lib/fastly/models/origin_inspector.rb +238 -0
- data/lib/fastly/models/origin_inspector_dimensions.rb +238 -0
- data/lib/fastly/models/origin_inspector_entry.rb +228 -0
- data/lib/fastly/models/origin_inspector_historical.rb +249 -0
- data/lib/fastly/models/origin_inspector_historical_data.rb +225 -0
- data/lib/fastly/models/origin_inspector_historical_meta.rb +297 -0
- data/lib/fastly/models/origin_inspector_historical_meta_filters.rb +235 -0
- data/lib/fastly/models/origin_inspector_measurements.rb +1728 -0
- data/lib/fastly/models/origin_inspector_realtime_entry.rb +241 -0
- data/lib/fastly/models/origin_inspector_realtime_entry_recorded.rb +208 -0
- data/lib/fastly/models/origin_inspector_subsequent_request_timestamp.rb +208 -0
- data/lib/fastly/models/origin_inspector_values.rb +1728 -0
- data/lib/fastly/models/pagination_cursor_meta.rb +227 -0
- data/lib/fastly/models/read_only_service_id.rb +207 -0
- data/lib/fastly/models/read_only_version.rb +207 -0
- data/lib/fastly/models/realtime_entry.rb +2 -7
- data/lib/fastly/models/realtime_entry_aggregated.rb +2397 -0
- data/lib/fastly/models/realtime_entry_recorded.rb +208 -0
- data/lib/fastly/models/realtime_measurements.rb +4 -2
- data/lib/fastly/models/recorded_timestamp.rb +208 -0
- data/lib/fastly/models/schemas_user_response.rb +5 -2
- data/lib/fastly/models/schemas_user_response_read_only.rb +235 -0
- data/lib/fastly/models/secret.rb +238 -0
- data/lib/fastly/models/secret_response.rb +249 -0
- data/lib/fastly/models/secret_store.rb +217 -0
- data/lib/fastly/models/secret_store_response.rb +238 -0
- data/lib/fastly/models/signing_key.rb +218 -0
- data/lib/fastly/models/subsequent_request_timestamp.rb +208 -0
- data/lib/fastly/models/sudo_generic_token_error.rb +216 -0
- data/lib/fastly/models/sudo_request.rb +244 -0
- data/lib/fastly/models/sudo_response.rb +217 -0
- data/lib/fastly/models/user.rb +3 -0
- data/lib/fastly/models/user_response.rb +4 -1
- data/lib/fastly/models/{user_response_all_of.rb → user_response_read_only.rb} +3 -3
- data/lib/fastly/models/values.rb +828 -0
- data/lib/fastly/version.rb +1 -1
- data/lib/fastly.rb +79 -8
- data/sig.json +1 -1
- metadata +160 -18
@@ -0,0 +1,132 @@
|
|
1
|
+
# Fastly::DomainInspectorRealtimeApi
|
2
|
+
|
3
|
+
|
4
|
+
```ruby
|
5
|
+
require 'fastly'
|
6
|
+
api_instance = Fastly::DomainInspectorRealtimeApi.new
|
7
|
+
```
|
8
|
+
|
9
|
+
## Methods
|
10
|
+
|
11
|
+
| Method | HTTP request | Description |
|
12
|
+
| ------ | ------------ | ----------- |
|
13
|
+
| [**get_domain_inspector_last120_seconds**](DomainInspectorRealtimeApi.md#get_domain_inspector_last120_seconds) | **GET** /v1/domains/{service_id}/ts/h | Get real-time domain data for the last 120 seconds |
|
14
|
+
| [**get_domain_inspector_last_max_entries**](DomainInspectorRealtimeApi.md#get_domain_inspector_last_max_entries) | **GET** /v1/domains/{service_id}/ts/h/limit/{max_entries} | Get a limited number of real-time domain data entries |
|
15
|
+
| [**get_domain_inspector_last_second**](DomainInspectorRealtimeApi.md#get_domain_inspector_last_second) | **GET** /v1/domains/{service_id}/ts/{start_timestamp} | Get real-time domain data from a specified time |
|
16
|
+
|
17
|
+
|
18
|
+
## `get_domain_inspector_last120_seconds()`
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
get_domain_inspector_last120_seconds(opts): <DomainInspector> # Get real-time domain data for the last 120 seconds
|
22
|
+
```
|
23
|
+
|
24
|
+
Get data for the 120 seconds preceding the latest timestamp available for a service.
|
25
|
+
|
26
|
+
### Examples
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
api_instance = Fastly::DomainInspectorRealtimeApi.new
|
30
|
+
opts = {
|
31
|
+
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
32
|
+
}
|
33
|
+
|
34
|
+
begin
|
35
|
+
# Get real-time domain data for the last 120 seconds
|
36
|
+
result = api_instance.get_domain_inspector_last120_seconds(opts)
|
37
|
+
p result
|
38
|
+
rescue Fastly::ApiError => e
|
39
|
+
puts "Error when calling DomainInspectorRealtimeApi->get_domain_inspector_last120_seconds: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Options
|
44
|
+
|
45
|
+
| Name | Type | Description | Notes |
|
46
|
+
| ---- | ---- | ----------- | ----- |
|
47
|
+
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
48
|
+
|
49
|
+
### Return type
|
50
|
+
|
51
|
+
[**DomainInspector**](DomainInspector.md)
|
52
|
+
|
53
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
54
|
+
[[Back to README]](../../README.md)
|
55
|
+
## `get_domain_inspector_last_max_entries()`
|
56
|
+
|
57
|
+
```ruby
|
58
|
+
get_domain_inspector_last_max_entries(opts): <DomainInspector> # Get a limited number of real-time domain data entries
|
59
|
+
```
|
60
|
+
|
61
|
+
Get data for the `max_entries` seconds preceding the latest timestamp available for a service, up to a maximum of 120 entries.
|
62
|
+
|
63
|
+
### Examples
|
64
|
+
|
65
|
+
```ruby
|
66
|
+
api_instance = Fastly::DomainInspectorRealtimeApi.new
|
67
|
+
opts = {
|
68
|
+
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
69
|
+
max_entries: 1, # Integer | Maximum number of results to show.
|
70
|
+
}
|
71
|
+
|
72
|
+
begin
|
73
|
+
# Get a limited number of real-time domain data entries
|
74
|
+
result = api_instance.get_domain_inspector_last_max_entries(opts)
|
75
|
+
p result
|
76
|
+
rescue Fastly::ApiError => e
|
77
|
+
puts "Error when calling DomainInspectorRealtimeApi->get_domain_inspector_last_max_entries: #{e}"
|
78
|
+
end
|
79
|
+
```
|
80
|
+
|
81
|
+
### Options
|
82
|
+
|
83
|
+
| Name | Type | Description | Notes |
|
84
|
+
| ---- | ---- | ----------- | ----- |
|
85
|
+
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
86
|
+
| **max_entries** | **Integer** | Maximum number of results to show. | |
|
87
|
+
|
88
|
+
### Return type
|
89
|
+
|
90
|
+
[**DomainInspector**](DomainInspector.md)
|
91
|
+
|
92
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
93
|
+
[[Back to README]](../../README.md)
|
94
|
+
## `get_domain_inspector_last_second()`
|
95
|
+
|
96
|
+
```ruby
|
97
|
+
get_domain_inspector_last_second(opts): <DomainInspector> # Get real-time domain data from a specified time
|
98
|
+
```
|
99
|
+
|
100
|
+
Get real-time domain data for the specified reporting period. Specify `0` to get a single entry for the last complete second. The `Timestamp` field included in the response provides the time index of the latest entry in the dataset and can be provided as the `start_timestamp` of the next request for a seamless continuation of the dataset from one request to the next. Due to processing latency, the earliest entry in the response dataset may be earlier than `start_timestamp` by the value of `AggregateDelay`.
|
101
|
+
|
102
|
+
### Examples
|
103
|
+
|
104
|
+
```ruby
|
105
|
+
api_instance = Fastly::DomainInspectorRealtimeApi.new
|
106
|
+
opts = {
|
107
|
+
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
108
|
+
start_timestamp: 56, # Integer | Timestamp in seconds (Unix epoch time).
|
109
|
+
}
|
110
|
+
|
111
|
+
begin
|
112
|
+
# Get real-time domain data from a specified time
|
113
|
+
result = api_instance.get_domain_inspector_last_second(opts)
|
114
|
+
p result
|
115
|
+
rescue Fastly::ApiError => e
|
116
|
+
puts "Error when calling DomainInspectorRealtimeApi->get_domain_inspector_last_second: #{e}"
|
117
|
+
end
|
118
|
+
```
|
119
|
+
|
120
|
+
### Options
|
121
|
+
|
122
|
+
| Name | Type | Description | Notes |
|
123
|
+
| ---- | ---- | ----------- | ----- |
|
124
|
+
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
125
|
+
| **start_timestamp** | **Integer** | Timestamp in seconds (Unix epoch time). | |
|
126
|
+
|
127
|
+
### Return type
|
128
|
+
|
129
|
+
[**DomainInspector**](DomainInspector.md)
|
130
|
+
|
131
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
132
|
+
[[Back to README]](../../README.md)
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# Fastly::DomainInspectorRealtimeEntry
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **recorded** | [**RecordedTimestamp**](RecordedTimestamp.md) | | [optional] |
|
8
|
+
| **aggregated** | [**Hash<String, DomainInspectorMeasurements>**](DomainInspectorMeasurements.md) | Groups [measurements](#measurements-data-model) by backend name and then by IP address. | [optional] |
|
9
|
+
| **datacenter** | **Hash<String, Hash<String, DomainInspectorMeasurements>>** | Groups [measurements](#measurements-data-model) by POP, then backend name, and then IP address. See the [POPs API](/reference/api/utils/pops/) for details about POP identifiers. | [optional] |
|
10
|
+
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
12
|
+
|
data/docs/EventAttributes.md
CHANGED
@@ -10,7 +10,7 @@
|
|
10
10
|
| **description** | **String** | Description of the event. | [optional] |
|
11
11
|
| **event_type** | **String** | Type of event. Can be used with `filter[event_type]` | [optional] |
|
12
12
|
| **ip** | **String** | IP addresses that the event was requested from. | [optional] |
|
13
|
-
| **metadata** | **Object
|
13
|
+
| **metadata** | **Hash<String, Object>** | Hash of key value pairs of additional information. | [optional] |
|
14
14
|
| **service_id** | **String** | | [optional][readonly] |
|
15
15
|
| **user_id** | **String** | | [optional][readonly] |
|
16
16
|
| **token_id** | **String** | | [optional][readonly] |
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# Fastly::HistoricalDomains
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **status** | **String** | Whether or not we were able to successfully execute the query. | [optional] |
|
8
|
+
| **meta** | [**HistoricalDomainsMeta**](HistoricalDomainsMeta.md) | | [optional] |
|
9
|
+
| **msg** | **String** | If the query was not successful, this will provide a string that explains why. | [optional] |
|
10
|
+
| **data** | [**Array<HistoricalDomainsData>**](HistoricalDomainsData.md) | A list of [entries](#entry-data-model), each representing one unique combination of dimensions, such as domain, region, or POP. | [optional] |
|
11
|
+
|
12
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
13
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# Fastly::HistoricalDomainsData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **dimensions** | [**DomainInspectorEntryDimensions**](DomainInspectorEntryDimensions.md) | | [optional] |
|
8
|
+
| **values** | [**Array<Values>**](Values.md) | An array of values representing the metric values at each point in time. Note that this dataset is sparse: only the keys with non-zero values will be included in the record. | [optional] |
|
9
|
+
|
10
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
11
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# Fastly::HistoricalDomainsMeta
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **start** | **String** | Start time that was used to perform the query as an ISO-8601-formatted date and time. | [optional] |
|
8
|
+
| **_end** | **String** | End time that was used to perform the query as an ISO-8601-formatted date and time. | [optional] |
|
9
|
+
| **downsample** | **String** | Downsample that was used to perform the query. One of `minute`, `hour`, or `day`. | [optional] |
|
10
|
+
| **metrics** | **String** | A comma-separated list of the metrics that were requested. | [optional] |
|
11
|
+
| **limit** | **Float** | The maximum number of results shown per page. | [optional] |
|
12
|
+
| **next_cursor** | **String** | A string that can be used to request the next page of results, if any. | [optional] |
|
13
|
+
| **sort** | **String** | A comma-separated list of keys the results are sorted by. | [optional] |
|
14
|
+
| **group_by** | **String** | A comma-separated list of dimensions being summed over in the query. | [optional] |
|
15
|
+
| **filters** | [**HistoricalDomainsMetaFilters**](HistoricalDomainsMetaFilters.md) | | [optional] |
|
16
|
+
|
17
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
18
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# Fastly::HistoricalDomainsMetaFilters
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **region** | **String** | | [optional] |
|
8
|
+
| **datacenter** | **String** | | [optional] |
|
9
|
+
| **domain** | **String** | | [optional] |
|
10
|
+
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
12
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# Fastly::HistoricalDomainsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **status** | **String** | Whether or not we were able to successfully execute the query. | [optional] |
|
8
|
+
| **meta** | [**HistoricalDomainsMeta**](HistoricalDomainsMeta.md) | | [optional] |
|
9
|
+
| **msg** | **String** | If the query was not successful, this will provide a string that explains why. | [optional] |
|
10
|
+
| **data** | [**Array<DomainInspectorEntry>**](DomainInspectorEntry.md) | A list of timeseries. Each individual timeseries represents a unique combination of dimensions, such as domain, region or POP. | [optional] |
|
11
|
+
|
12
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
13
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::HistoricalDomainsResponseAllOf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<DomainInspectorEntry>**](DomainInspectorEntry.md) | A list of timeseries. Each individual timeseries represents a unique combination of dimensions, such as domain, region or POP. | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# Fastly::HistoricalOriginsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **status** | **String** | Whether or not we were able to successfully execute the query. | [optional] |
|
8
|
+
| **meta** | [**OriginInspectorHistoricalMeta**](OriginInspectorHistoricalMeta.md) | | [optional] |
|
9
|
+
| **msg** | **String** | If the query was not successful, this will provide a string that explains why. | [optional] |
|
10
|
+
| **data** | [**Array<OriginInspectorEntry>**](OriginInspectorEntry.md) | A list of timeseries. Each individual timeseries represents a unique combination of dimensions, such as origin host, region or POP. | [optional] |
|
11
|
+
|
12
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
13
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::HistoricalOriginsResponseAllOf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **data** | [**Array<OriginInspectorEntry>**](OriginInspectorEntry.md) | A list of timeseries. Each individual timeseries represents a unique combination of dimensions, such as origin host, region or POP. | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
data/docs/IamRolesApi.md
CHANGED
@@ -10,12 +10,92 @@ api_instance = Fastly::IamRolesApi.new
|
|
10
10
|
|
11
11
|
| Method | HTTP request | Description |
|
12
12
|
| ------ | ------------ | ----------- |
|
13
|
+
| [**add_role_permissions**](IamRolesApi.md#add_role_permissions) | **POST** /roles/{role_id}/permissions | Add permissions to a role |
|
14
|
+
| [**create_a_role**](IamRolesApi.md#create_a_role) | **POST** /roles | Create a role |
|
13
15
|
| [**delete_a_role**](IamRolesApi.md#delete_a_role) | **DELETE** /roles/{role_id} | Delete a role |
|
14
16
|
| [**get_a_role**](IamRolesApi.md#get_a_role) | **GET** /roles/{role_id} | Get a role |
|
15
17
|
| [**list_role_permissions**](IamRolesApi.md#list_role_permissions) | **GET** /roles/{role_id}/permissions | List permissions in a role |
|
16
18
|
| [**list_roles**](IamRolesApi.md#list_roles) | **GET** /roles | List roles |
|
19
|
+
| [**remove_role_permissions**](IamRolesApi.md#remove_role_permissions) | **DELETE** /roles/{role_id}/permissions | Remove permissions from a role |
|
20
|
+
| [**update_a_role**](IamRolesApi.md#update_a_role) | **PATCH** /roles/{role_id} | Update a role |
|
17
21
|
|
18
22
|
|
23
|
+
## `add_role_permissions()`
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
add_role_permissions(opts): Object # Add permissions to a role
|
27
|
+
```
|
28
|
+
|
29
|
+
Add permissions to a role.
|
30
|
+
|
31
|
+
### Examples
|
32
|
+
|
33
|
+
```ruby
|
34
|
+
api_instance = Fastly::IamRolesApi.new
|
35
|
+
opts = {
|
36
|
+
role_id: 'role_id_example', # String | Alphanumeric string identifying the role.
|
37
|
+
request_body: { key: 3.56}, # Hash<String, Object> |
|
38
|
+
}
|
39
|
+
|
40
|
+
begin
|
41
|
+
# Add permissions to a role
|
42
|
+
result = api_instance.add_role_permissions(opts)
|
43
|
+
p result
|
44
|
+
rescue Fastly::ApiError => e
|
45
|
+
puts "Error when calling IamRolesApi->add_role_permissions: #{e}"
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
### Options
|
50
|
+
|
51
|
+
| Name | Type | Description | Notes |
|
52
|
+
| ---- | ---- | ----------- | ----- |
|
53
|
+
| **role_id** | **String** | Alphanumeric string identifying the role. | |
|
54
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
55
|
+
|
56
|
+
### Return type
|
57
|
+
|
58
|
+
**Object**
|
59
|
+
|
60
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
61
|
+
[[Back to README]](../../README.md)
|
62
|
+
## `create_a_role()`
|
63
|
+
|
64
|
+
```ruby
|
65
|
+
create_a_role(opts): Object # Create a role
|
66
|
+
```
|
67
|
+
|
68
|
+
Create a role.
|
69
|
+
|
70
|
+
### Examples
|
71
|
+
|
72
|
+
```ruby
|
73
|
+
api_instance = Fastly::IamRolesApi.new
|
74
|
+
opts = {
|
75
|
+
request_body: { key: 3.56}, # Hash<String, Object> |
|
76
|
+
}
|
77
|
+
|
78
|
+
begin
|
79
|
+
# Create a role
|
80
|
+
result = api_instance.create_a_role(opts)
|
81
|
+
p result
|
82
|
+
rescue Fastly::ApiError => e
|
83
|
+
puts "Error when calling IamRolesApi->create_a_role: #{e}"
|
84
|
+
end
|
85
|
+
```
|
86
|
+
|
87
|
+
### Options
|
88
|
+
|
89
|
+
| Name | Type | Description | Notes |
|
90
|
+
| ---- | ---- | ----------- | ----- |
|
91
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
92
|
+
|
93
|
+
### Return type
|
94
|
+
|
95
|
+
**Object**
|
96
|
+
|
97
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
98
|
+
[[Back to README]](../../README.md)
|
19
99
|
## `delete_a_role()`
|
20
100
|
|
21
101
|
```ruby
|
@@ -165,3 +245,80 @@ end
|
|
165
245
|
|
166
246
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
167
247
|
[[Back to README]](../../README.md)
|
248
|
+
## `remove_role_permissions()`
|
249
|
+
|
250
|
+
```ruby
|
251
|
+
remove_role_permissions(opts) # Remove permissions from a role
|
252
|
+
```
|
253
|
+
|
254
|
+
Remove permissions from a role.
|
255
|
+
|
256
|
+
### Examples
|
257
|
+
|
258
|
+
```ruby
|
259
|
+
api_instance = Fastly::IamRolesApi.new
|
260
|
+
opts = {
|
261
|
+
role_id: 'role_id_example', # String | Alphanumeric string identifying the role.
|
262
|
+
request_body: { key: 3.56}, # Hash<String, Object> |
|
263
|
+
}
|
264
|
+
|
265
|
+
begin
|
266
|
+
# Remove permissions from a role
|
267
|
+
api_instance.remove_role_permissions(opts)
|
268
|
+
rescue Fastly::ApiError => e
|
269
|
+
puts "Error when calling IamRolesApi->remove_role_permissions: #{e}"
|
270
|
+
end
|
271
|
+
```
|
272
|
+
|
273
|
+
### Options
|
274
|
+
|
275
|
+
| Name | Type | Description | Notes |
|
276
|
+
| ---- | ---- | ----------- | ----- |
|
277
|
+
| **role_id** | **String** | Alphanumeric string identifying the role. | |
|
278
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
279
|
+
|
280
|
+
### Return type
|
281
|
+
|
282
|
+
nil (empty response body)
|
283
|
+
|
284
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
285
|
+
[[Back to README]](../../README.md)
|
286
|
+
## `update_a_role()`
|
287
|
+
|
288
|
+
```ruby
|
289
|
+
update_a_role(opts): Object # Update a role
|
290
|
+
```
|
291
|
+
|
292
|
+
Update a role.
|
293
|
+
|
294
|
+
### Examples
|
295
|
+
|
296
|
+
```ruby
|
297
|
+
api_instance = Fastly::IamRolesApi.new
|
298
|
+
opts = {
|
299
|
+
role_id: 'role_id_example', # String | Alphanumeric string identifying the role.
|
300
|
+
request_body: { key: 3.56}, # Hash<String, Object> |
|
301
|
+
}
|
302
|
+
|
303
|
+
begin
|
304
|
+
# Update a role
|
305
|
+
result = api_instance.update_a_role(opts)
|
306
|
+
p result
|
307
|
+
rescue Fastly::ApiError => e
|
308
|
+
puts "Error when calling IamRolesApi->update_a_role: #{e}"
|
309
|
+
end
|
310
|
+
```
|
311
|
+
|
312
|
+
### Options
|
313
|
+
|
314
|
+
| Name | Type | Description | Notes |
|
315
|
+
| ---- | ---- | ----------- | ----- |
|
316
|
+
| **role_id** | **String** | Alphanumeric string identifying the role. | |
|
317
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
318
|
+
|
319
|
+
### Return type
|
320
|
+
|
321
|
+
**Object**
|
322
|
+
|
323
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
324
|
+
[[Back to README]](../../README.md)
|
data/docs/IamServiceGroupsApi.md
CHANGED
@@ -10,12 +10,92 @@ api_instance = Fastly::IamServiceGroupsApi.new
|
|
10
10
|
|
11
11
|
| Method | HTTP request | Description |
|
12
12
|
| ------ | ------------ | ----------- |
|
13
|
+
| [**add_service_group_services**](IamServiceGroupsApi.md#add_service_group_services) | **POST** /service-groups/{service_group_id}/services | Add services in a service group |
|
14
|
+
| [**create_a_service_group**](IamServiceGroupsApi.md#create_a_service_group) | **POST** /service-groups | Create a service group |
|
13
15
|
| [**delete_a_service_group**](IamServiceGroupsApi.md#delete_a_service_group) | **DELETE** /service-groups/{service_group_id} | Delete a service group |
|
14
16
|
| [**get_a_service_group**](IamServiceGroupsApi.md#get_a_service_group) | **GET** /service-groups/{service_group_id} | Get a service group |
|
15
17
|
| [**list_service_group_services**](IamServiceGroupsApi.md#list_service_group_services) | **GET** /service-groups/{service_group_id}/services | List services to a service group |
|
16
18
|
| [**list_service_groups**](IamServiceGroupsApi.md#list_service_groups) | **GET** /service-groups | List service groups |
|
19
|
+
| [**remove_service_group_services**](IamServiceGroupsApi.md#remove_service_group_services) | **DELETE** /service-groups/{service_group_id}/services | Remove services from a service group |
|
20
|
+
| [**update_a_service_group**](IamServiceGroupsApi.md#update_a_service_group) | **PATCH** /service-groups/{service_group_id} | Update a service group |
|
17
21
|
|
18
22
|
|
23
|
+
## `add_service_group_services()`
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
add_service_group_services(opts): Object # Add services in a service group
|
27
|
+
```
|
28
|
+
|
29
|
+
Add services in a service group.
|
30
|
+
|
31
|
+
### Examples
|
32
|
+
|
33
|
+
```ruby
|
34
|
+
api_instance = Fastly::IamServiceGroupsApi.new
|
35
|
+
opts = {
|
36
|
+
service_group_id: 'service_group_id_example', # String | Alphanumeric string identifying the service group.
|
37
|
+
request_body: { key: 3.56}, # Hash<String, Object> |
|
38
|
+
}
|
39
|
+
|
40
|
+
begin
|
41
|
+
# Add services in a service group
|
42
|
+
result = api_instance.add_service_group_services(opts)
|
43
|
+
p result
|
44
|
+
rescue Fastly::ApiError => e
|
45
|
+
puts "Error when calling IamServiceGroupsApi->add_service_group_services: #{e}"
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
### Options
|
50
|
+
|
51
|
+
| Name | Type | Description | Notes |
|
52
|
+
| ---- | ---- | ----------- | ----- |
|
53
|
+
| **service_group_id** | **String** | Alphanumeric string identifying the service group. | |
|
54
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
55
|
+
|
56
|
+
### Return type
|
57
|
+
|
58
|
+
**Object**
|
59
|
+
|
60
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
61
|
+
[[Back to README]](../../README.md)
|
62
|
+
## `create_a_service_group()`
|
63
|
+
|
64
|
+
```ruby
|
65
|
+
create_a_service_group(opts): Object # Create a service group
|
66
|
+
```
|
67
|
+
|
68
|
+
Create a service group.
|
69
|
+
|
70
|
+
### Examples
|
71
|
+
|
72
|
+
```ruby
|
73
|
+
api_instance = Fastly::IamServiceGroupsApi.new
|
74
|
+
opts = {
|
75
|
+
request_body: { key: 3.56}, # Hash<String, Object> |
|
76
|
+
}
|
77
|
+
|
78
|
+
begin
|
79
|
+
# Create a service group
|
80
|
+
result = api_instance.create_a_service_group(opts)
|
81
|
+
p result
|
82
|
+
rescue Fastly::ApiError => e
|
83
|
+
puts "Error when calling IamServiceGroupsApi->create_a_service_group: #{e}"
|
84
|
+
end
|
85
|
+
```
|
86
|
+
|
87
|
+
### Options
|
88
|
+
|
89
|
+
| Name | Type | Description | Notes |
|
90
|
+
| ---- | ---- | ----------- | ----- |
|
91
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
92
|
+
|
93
|
+
### Return type
|
94
|
+
|
95
|
+
**Object**
|
96
|
+
|
97
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
98
|
+
[[Back to README]](../../README.md)
|
19
99
|
## `delete_a_service_group()`
|
20
100
|
|
21
101
|
```ruby
|
@@ -169,3 +249,80 @@ end
|
|
169
249
|
|
170
250
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
171
251
|
[[Back to README]](../../README.md)
|
252
|
+
## `remove_service_group_services()`
|
253
|
+
|
254
|
+
```ruby
|
255
|
+
remove_service_group_services(opts) # Remove services from a service group
|
256
|
+
```
|
257
|
+
|
258
|
+
Remove services from a service group.
|
259
|
+
|
260
|
+
### Examples
|
261
|
+
|
262
|
+
```ruby
|
263
|
+
api_instance = Fastly::IamServiceGroupsApi.new
|
264
|
+
opts = {
|
265
|
+
service_group_id: 'service_group_id_example', # String | Alphanumeric string identifying the service group.
|
266
|
+
request_body: { key: 3.56}, # Hash<String, Object> |
|
267
|
+
}
|
268
|
+
|
269
|
+
begin
|
270
|
+
# Remove services from a service group
|
271
|
+
api_instance.remove_service_group_services(opts)
|
272
|
+
rescue Fastly::ApiError => e
|
273
|
+
puts "Error when calling IamServiceGroupsApi->remove_service_group_services: #{e}"
|
274
|
+
end
|
275
|
+
```
|
276
|
+
|
277
|
+
### Options
|
278
|
+
|
279
|
+
| Name | Type | Description | Notes |
|
280
|
+
| ---- | ---- | ----------- | ----- |
|
281
|
+
| **service_group_id** | **String** | Alphanumeric string identifying the service group. | |
|
282
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
283
|
+
|
284
|
+
### Return type
|
285
|
+
|
286
|
+
nil (empty response body)
|
287
|
+
|
288
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
289
|
+
[[Back to README]](../../README.md)
|
290
|
+
## `update_a_service_group()`
|
291
|
+
|
292
|
+
```ruby
|
293
|
+
update_a_service_group(opts): Object # Update a service group
|
294
|
+
```
|
295
|
+
|
296
|
+
Update a service group.
|
297
|
+
|
298
|
+
### Examples
|
299
|
+
|
300
|
+
```ruby
|
301
|
+
api_instance = Fastly::IamServiceGroupsApi.new
|
302
|
+
opts = {
|
303
|
+
service_group_id: 'service_group_id_example', # String | Alphanumeric string identifying the service group.
|
304
|
+
request_body: { key: 3.56}, # Hash<String, Object> |
|
305
|
+
}
|
306
|
+
|
307
|
+
begin
|
308
|
+
# Update a service group
|
309
|
+
result = api_instance.update_a_service_group(opts)
|
310
|
+
p result
|
311
|
+
rescue Fastly::ApiError => e
|
312
|
+
puts "Error when calling IamServiceGroupsApi->update_a_service_group: #{e}"
|
313
|
+
end
|
314
|
+
```
|
315
|
+
|
316
|
+
### Options
|
317
|
+
|
318
|
+
| Name | Type | Description | Notes |
|
319
|
+
| ---- | ---- | ----------- | ----- |
|
320
|
+
| **service_group_id** | **String** | Alphanumeric string identifying the service group. | |
|
321
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
322
|
+
|
323
|
+
### Return type
|
324
|
+
|
325
|
+
**Object**
|
326
|
+
|
327
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
328
|
+
[[Back to README]](../../README.md)
|