fastly 5.3.1 → 6.0.1
Sign up to get free protection for your applications and to get access to all the features.
- 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
data/docs/SudoApi.md
ADDED
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
# Fastly::SudoApi
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
```ruby
|
|
5
|
+
require 'fastly'
|
|
6
|
+
api_instance = Fastly::SudoApi.new
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Methods
|
|
10
|
+
|
|
11
|
+
| Method | HTTP request | Description |
|
|
12
|
+
| ------ | ------------ | ----------- |
|
|
13
|
+
| [**request_sudo_access**](SudoApi.md#request_sudo_access) | **POST** /sudo | Request Sudo access |
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
## `request_sudo_access()`
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
request_sudo_access(opts): <SudoResponse> # Request Sudo access
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
Re-authenticate to allow the provided user to obtain sudo access.
|
|
23
|
+
|
|
24
|
+
### Examples
|
|
25
|
+
|
|
26
|
+
```ruby
|
|
27
|
+
api_instance = Fastly::SudoApi.new
|
|
28
|
+
opts = {
|
|
29
|
+
sudo_request: Fastly::SudoRequest.new({username: 'username_example', password: 'password_example'}), # SudoRequest |
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
begin
|
|
33
|
+
# Request Sudo access
|
|
34
|
+
result = api_instance.request_sudo_access(opts)
|
|
35
|
+
p result
|
|
36
|
+
rescue Fastly::ApiError => e
|
|
37
|
+
puts "Error when calling SudoApi->request_sudo_access: #{e}"
|
|
38
|
+
end
|
|
39
|
+
```
|
|
40
|
+
|
|
41
|
+
### Options
|
|
42
|
+
|
|
43
|
+
| Name | Type | Description | Notes |
|
|
44
|
+
| ---- | ---- | ----------- | ----- |
|
|
45
|
+
| **sudo_request** | [**SudoRequest**](SudoRequest.md) | | [optional] |
|
|
46
|
+
|
|
47
|
+
### Return type
|
|
48
|
+
|
|
49
|
+
[**SudoResponse**](SudoResponse.md)
|
|
50
|
+
|
|
51
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
52
|
+
[[Back to README]](../../README.md)
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::SudoGenericTokenError
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **msg** | **String** | | [optional] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
data/docs/SudoRequest.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# Fastly::SudoRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **username** | **String** | | |
|
|
8
|
+
| **password** | **String** | | |
|
|
9
|
+
| **expiry_time** | **String** | | [optional] |
|
|
10
|
+
|
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
12
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# Fastly::SudoResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **expiry_time** | **Time** | A UTC time-stamp of when sudo access will expire. If blank, sudo access expires five minutes after the request. | [optional] |
|
|
8
|
+
|
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
10
|
+
|
data/docs/TokensApi.md
CHANGED
|
@@ -10,6 +10,8 @@ api_instance = Fastly::TokensApi.new
|
|
|
10
10
|
|
|
11
11
|
| Method | HTTP request | Description |
|
|
12
12
|
| ------ | ------------ | ----------- |
|
|
13
|
+
| [**bulk_revoke_tokens**](TokensApi.md#bulk_revoke_tokens) | **DELETE** /tokens | Revoke multiple tokens |
|
|
14
|
+
| [**create_token**](TokensApi.md#create_token) | **POST** /tokens | Create a token |
|
|
13
15
|
| [**get_token**](TokensApi.md#get_token) | **GET** /tokens/{token_id} | Get a token |
|
|
14
16
|
| [**get_token_current**](TokensApi.md#get_token_current) | **GET** /tokens/self | Get the current token |
|
|
15
17
|
| [**list_tokens_customer**](TokensApi.md#list_tokens_customer) | **GET** /customer/{customer_id}/tokens | List tokens for a customer |
|
|
@@ -18,6 +20,74 @@ api_instance = Fastly::TokensApi.new
|
|
|
18
20
|
| [**revoke_token_current**](TokensApi.md#revoke_token_current) | **DELETE** /tokens/self | Revoke the current token |
|
|
19
21
|
|
|
20
22
|
|
|
23
|
+
## `bulk_revoke_tokens()`
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
bulk_revoke_tokens(opts) # Revoke multiple tokens
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Revoke Tokens in bulk format. Users may only revoke their own tokens. Superusers may revoke tokens of others.
|
|
30
|
+
|
|
31
|
+
### Examples
|
|
32
|
+
|
|
33
|
+
```ruby
|
|
34
|
+
api_instance = Fastly::TokensApi.new
|
|
35
|
+
opts = {
|
|
36
|
+
request_body: { key: 3.56}, # Hash<String, Object> |
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
begin
|
|
40
|
+
# Revoke multiple tokens
|
|
41
|
+
api_instance.bulk_revoke_tokens(opts)
|
|
42
|
+
rescue Fastly::ApiError => e
|
|
43
|
+
puts "Error when calling TokensApi->bulk_revoke_tokens: #{e}"
|
|
44
|
+
end
|
|
45
|
+
```
|
|
46
|
+
|
|
47
|
+
### Options
|
|
48
|
+
|
|
49
|
+
| Name | Type | Description | Notes |
|
|
50
|
+
| ---- | ---- | ----------- | ----- |
|
|
51
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
|
52
|
+
|
|
53
|
+
### Return type
|
|
54
|
+
|
|
55
|
+
nil (empty response body)
|
|
56
|
+
|
|
57
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
58
|
+
[[Back to README]](../../README.md)
|
|
59
|
+
## `create_token()`
|
|
60
|
+
|
|
61
|
+
```ruby
|
|
62
|
+
create_token: <TokenCreatedResponse> # Create a token
|
|
63
|
+
```
|
|
64
|
+
|
|
65
|
+
Create an API token. If two-factor authentication is enabled for your account, review [the instructions](/reference/api/auth-tokens/user/) for including a one-time password in the request.
|
|
66
|
+
|
|
67
|
+
### Examples
|
|
68
|
+
|
|
69
|
+
```ruby
|
|
70
|
+
api_instance = Fastly::TokensApi.new
|
|
71
|
+
|
|
72
|
+
begin
|
|
73
|
+
# Create a token
|
|
74
|
+
result = api_instance.create_token
|
|
75
|
+
p result
|
|
76
|
+
rescue Fastly::ApiError => e
|
|
77
|
+
puts "Error when calling TokensApi->create_token: #{e}"
|
|
78
|
+
end
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
### Options
|
|
82
|
+
|
|
83
|
+
This endpoint does not need any parameter.
|
|
84
|
+
|
|
85
|
+
### Return type
|
|
86
|
+
|
|
87
|
+
[**TokenCreatedResponse**](TokenCreatedResponse.md)
|
|
88
|
+
|
|
89
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
90
|
+
[[Back to README]](../../README.md)
|
|
21
91
|
## `get_token()`
|
|
22
92
|
|
|
23
93
|
```ruby
|
data/docs/Values.md
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
1
|
+
# Fastly::Values
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **edge_requests** | **Integer** | Number of requests sent by end users to Fastly. | [optional] |
|
|
8
|
+
| **edge_resp_header_bytes** | **Integer** | Total header bytes delivered from Fastly to the end user. | [optional] |
|
|
9
|
+
| **edge_resp_body_bytes** | **Integer** | Total body bytes delivered from Fastly to the end user. | [optional] |
|
|
10
|
+
| **status_1xx** | **Integer** | Number of 1xx \"Informational\" category status codes delivered. | [optional] |
|
|
11
|
+
| **status_2xx** | **Integer** | Number of 2xx \"Success\" status codes delivered. | [optional] |
|
|
12
|
+
| **status_3xx** | **Integer** | Number of 3xx \"Redirection\" codes delivered. | [optional] |
|
|
13
|
+
| **status_4xx** | **Integer** | Number of 4xx \"Client Error\" codes delivered. | [optional] |
|
|
14
|
+
| **status_5xx** | **Integer** | Number of 5xx \"Server Error\" codes delivered. | [optional] |
|
|
15
|
+
| **status_200** | **Integer** | Number of responses delivered with status code 200 (Success). | [optional] |
|
|
16
|
+
| **status_204** | **Integer** | Number of responses delivered with status code 204 (No Content). | [optional] |
|
|
17
|
+
| **status_206** | **Integer** | Number of responses delivered with status code 206 (Partial Content). | [optional] |
|
|
18
|
+
| **status_301** | **Integer** | Number of responses delivered with status code 301 (Moved Permanently). | [optional] |
|
|
19
|
+
| **status_302** | **Integer** | Number of responses delivered with status code 302 (Found). | [optional] |
|
|
20
|
+
| **status_304** | **Integer** | Number of responses delivered with status code 304 (Not Modified). | [optional] |
|
|
21
|
+
| **status_400** | **Integer** | Number of responses delivered with status code 400 (Bad Request). | [optional] |
|
|
22
|
+
| **status_401** | **Integer** | Number of responses delivered with status code 401 (Unauthorized). | [optional] |
|
|
23
|
+
| **status_403** | **Integer** | Number of responses delivered with status code 403 (Forbidden). | [optional] |
|
|
24
|
+
| **status_404** | **Integer** | Number of responses delivered with status code 404 (Not Found). | [optional] |
|
|
25
|
+
| **status_416** | **Integer** | Number of responses delivered with status code 416 (Range Not Satisfiable). | [optional] |
|
|
26
|
+
| **status_429** | **Integer** | Number of responses delivered with status code 429 (Too Many Requests). | [optional] |
|
|
27
|
+
| **status_500** | **Integer** | Number of responses delivered with status code 500 (Internal Server Error). | [optional] |
|
|
28
|
+
| **status_501** | **Integer** | Number of responses delivered with status code 501 (Not Implemented). | [optional] |
|
|
29
|
+
| **status_502** | **Integer** | Number of responses delivered with status code 502 (Bad Gateway). | [optional] |
|
|
30
|
+
| **status_503** | **Integer** | Number of responses delivered with status code 503 (Service Unavailable). | [optional] |
|
|
31
|
+
| **status_504** | **Integer** | Number of responses delivered with status code 504 (Gateway Timeout). | [optional] |
|
|
32
|
+
| **status_505** | **Integer** | Number of responses delivered with status code 505 (HTTP Version Not Supported). | [optional] |
|
|
33
|
+
| **requests** | **Integer** | Number of requests processed. | [optional] |
|
|
34
|
+
| **resp_header_bytes** | **Integer** | Total header bytes delivered. | [optional] |
|
|
35
|
+
| **resp_body_bytes** | **Integer** | Total body bytes delivered. | [optional] |
|
|
36
|
+
| **bereq_header_bytes** | **Integer** | Total header bytes sent to origin. | [optional] |
|
|
37
|
+
| **bereq_body_bytes** | **Integer** | Total body bytes sent to origin. | [optional] |
|
|
38
|
+
| **edge_hit_requests** | **Integer** | Number of requests sent by end users to Fastly that resulted in a hit at the edge. | [optional] |
|
|
39
|
+
| **edge_miss_requests** | **Integer** | Number of requests sent by end users to Fastly that resulted in a miss at the edge. | [optional] |
|
|
40
|
+
| **origin_fetches** | **Integer** | Number of requests sent to origin. | [optional] |
|
|
41
|
+
| **origin_fetch_resp_header_bytes** | **Integer** | Total header bytes received from origin. | [optional] |
|
|
42
|
+
| **origin_fetch_resp_body_bytes** | **Integer** | Total body bytes received from origin. | [optional] |
|
|
43
|
+
| **bandwidth** | **Integer** | Total bytes delivered (`resp_header_bytes` + `resp_body_bytes` + `bereq_header_bytes` + `bereq_body_bytes`). | [optional] |
|
|
44
|
+
| **edge_hit_ratio** | **Float** | Ratio of cache hits to cache misses at the edge, between 0 and 1 (`edge_hit_requests` / (`edge_hit_requests` + `edge_miss_requests`)). | [optional] |
|
|
45
|
+
| **origin_offload** | **Float** | Ratio of response bytes delivered from the edge compared to what is delivered from origin, between 0 and 1. (`edge_resp_body_bytes` + `edge_resp_header_bytes`) / (`origin_fetch_resp_body_bytes` + `origin_fetch_resp_header_bytes` + `edge_resp_body_bytes` + `edge_resp_header_bytes`). | [optional] |
|
|
46
|
+
| **origin_status_200** | **Integer** | Number of responses received from origin with status code 200 (Success). | [optional] |
|
|
47
|
+
| **origin_status_204** | **Integer** | Number of responses received from origin with status code 204 (No Content). | [optional] |
|
|
48
|
+
| **origin_status_206** | **Integer** | Number of responses received from origin with status code 206 (Partial Content). | [optional] |
|
|
49
|
+
| **origin_status_301** | **Integer** | Number of responses received from origin with status code 301 (Moved Permanently). | [optional] |
|
|
50
|
+
| **origin_status_302** | **Integer** | Number of responses received from origin with status code 302 (Found). | [optional] |
|
|
51
|
+
| **origin_status_304** | **Integer** | Number of responses received from origin with status code 304 (Not Modified). | [optional] |
|
|
52
|
+
| **origin_status_400** | **Integer** | Number of responses received from origin with status code 400 (Bad Request). | [optional] |
|
|
53
|
+
| **origin_status_401** | **Integer** | Number of responses received from origin with status code 401 (Unauthorized). | [optional] |
|
|
54
|
+
| **origin_status_403** | **Integer** | Number of responses received from origin with status code 403 (Forbidden). | [optional] |
|
|
55
|
+
| **origin_status_404** | **Integer** | Number of responses received from origin with status code 404 (Not Found). | [optional] |
|
|
56
|
+
| **origin_status_416** | **Integer** | Number of responses received from origin with status code 416 (Range Not Satisfiable). | [optional] |
|
|
57
|
+
| **origin_status_429** | **Integer** | Number of responses received from origin with status code 429 (Too Many Requests). | [optional] |
|
|
58
|
+
| **origin_status_500** | **Integer** | Number of responses received from origin with status code 500 (Internal Server Error). | [optional] |
|
|
59
|
+
| **origin_status_501** | **Integer** | Number of responses received from origin with status code 501 (Not Implemented). | [optional] |
|
|
60
|
+
| **origin_status_502** | **Integer** | Number of responses received from origin with status code 502 (Bad Gateway). | [optional] |
|
|
61
|
+
| **origin_status_503** | **Integer** | Number of responses received from origin with status code 503 (Service Unavailable). | [optional] |
|
|
62
|
+
| **origin_status_504** | **Integer** | Number of responses received from origin with status code 504 (Gateway Timeout). | [optional] |
|
|
63
|
+
| **origin_status_505** | **Integer** | Number of responses received from origin with status code 505 (HTTP Version Not Supported). | [optional] |
|
|
64
|
+
| **origin_status_1xx** | **Integer** | Number of \"Informational\" category status codes received from origin. | [optional] |
|
|
65
|
+
| **origin_status_2xx** | **Integer** | Number of \"Success\" status codes received from origin. | [optional] |
|
|
66
|
+
| **origin_status_3xx** | **Integer** | Number of \"Redirection\" codes received from origin. | [optional] |
|
|
67
|
+
| **origin_status_4xx** | **Integer** | Number of \"Client Error\" codes received from origin. | [optional] |
|
|
68
|
+
| **origin_status_5xx** | **Integer** | Number of \"Server Error\" codes received from origin. | [optional] |
|
|
69
|
+
|
|
70
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
|
71
|
+
|
data/docs/WafActiveRulesApi.md
CHANGED
|
@@ -10,6 +10,7 @@ api_instance = Fastly::WafActiveRulesApi.new
|
|
|
10
10
|
|
|
11
11
|
| Method | HTTP request | Description |
|
|
12
12
|
| ------ | ------------ | ----------- |
|
|
13
|
+
| [**bulk_delete_waf_active_rules**](WafActiveRulesApi.md#bulk_delete_waf_active_rules) | **DELETE** /waf/firewalls/{firewall_id}/versions/{version_id}/active-rules | Delete multiple active rules from a WAF |
|
|
13
14
|
| [**bulk_update_waf_active_rules**](WafActiveRulesApi.md#bulk_update_waf_active_rules) | **PATCH** /waf/firewalls/{firewall_id}/versions/{version_id}/active-rules/bulk | Update multiple active rules |
|
|
14
15
|
| [**create_waf_active_rule**](WafActiveRulesApi.md#create_waf_active_rule) | **POST** /waf/firewalls/{firewall_id}/versions/{version_id}/active-rules | Add a rule to a WAF as an active rule |
|
|
15
16
|
| [**create_waf_active_rules_tag**](WafActiveRulesApi.md#create_waf_active_rules_tag) | **POST** /waf/firewalls/{firewall_id}/versions/{version_id}/tags/{waf_tag_name}/active-rules | Create active rules by tag |
|
|
@@ -19,6 +20,46 @@ api_instance = Fastly::WafActiveRulesApi.new
|
|
|
19
20
|
| [**update_waf_active_rule**](WafActiveRulesApi.md#update_waf_active_rule) | **PATCH** /waf/firewalls/{firewall_id}/versions/{version_id}/active-rules/{waf_rule_id} | Update an active rule |
|
|
20
21
|
|
|
21
22
|
|
|
23
|
+
## `bulk_delete_waf_active_rules()`
|
|
24
|
+
|
|
25
|
+
```ruby
|
|
26
|
+
bulk_delete_waf_active_rules(opts) # Delete multiple active rules from a WAF
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
Delete many active rules on a particular firewall version using the active rule ID. Limited to 500 rules per request.
|
|
30
|
+
|
|
31
|
+
### Examples
|
|
32
|
+
|
|
33
|
+
```ruby
|
|
34
|
+
api_instance = Fastly::WafActiveRulesApi.new
|
|
35
|
+
opts = {
|
|
36
|
+
firewall_id: 'firewall_id_example', # String | Alphanumeric string identifying a WAF Firewall.
|
|
37
|
+
version_id: 56, # Integer | Integer identifying a service version.
|
|
38
|
+
request_body: { key: 3.56}, # Hash<String, Object> |
|
|
39
|
+
}
|
|
40
|
+
|
|
41
|
+
begin
|
|
42
|
+
# Delete multiple active rules from a WAF
|
|
43
|
+
api_instance.bulk_delete_waf_active_rules(opts)
|
|
44
|
+
rescue Fastly::ApiError => e
|
|
45
|
+
puts "Error when calling WafActiveRulesApi->bulk_delete_waf_active_rules: #{e}"
|
|
46
|
+
end
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
### Options
|
|
50
|
+
|
|
51
|
+
| Name | Type | Description | Notes |
|
|
52
|
+
| ---- | ---- | ----------- | ----- |
|
|
53
|
+
| **firewall_id** | **String** | Alphanumeric string identifying a WAF Firewall. | |
|
|
54
|
+
| **version_id** | **Integer** | Integer identifying a service version. | |
|
|
55
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
|
56
|
+
|
|
57
|
+
### Return type
|
|
58
|
+
|
|
59
|
+
nil (empty response body)
|
|
60
|
+
|
|
61
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
62
|
+
[[Back to README]](../../README.md)
|
|
22
63
|
## `bulk_update_waf_active_rules()`
|
|
23
64
|
|
|
24
65
|
```ruby
|
|
@@ -94,6 +94,83 @@ module Fastly
|
|
|
94
94
|
return data, status_code, headers
|
|
95
95
|
end
|
|
96
96
|
|
|
97
|
+
# Create an ACL entry
|
|
98
|
+
# Add an ACL entry to an ACL.
|
|
99
|
+
# @option opts [String] :service_id Alphanumeric string identifying the service. (required)
|
|
100
|
+
# @option opts [String] :acl_id Alphanumeric string identifying a ACL. (required)
|
|
101
|
+
# @option opts [AclEntry] :acl_entry
|
|
102
|
+
# @return [AclEntryResponse]
|
|
103
|
+
def create_acl_entry(opts = {})
|
|
104
|
+
data, _status_code, _headers = create_acl_entry_with_http_info(opts)
|
|
105
|
+
data
|
|
106
|
+
end
|
|
107
|
+
|
|
108
|
+
# Create an ACL entry
|
|
109
|
+
# Add an ACL entry to an ACL.
|
|
110
|
+
# @option opts [String] :service_id Alphanumeric string identifying the service. (required)
|
|
111
|
+
# @option opts [String] :acl_id Alphanumeric string identifying a ACL. (required)
|
|
112
|
+
# @option opts [AclEntry] :acl_entry
|
|
113
|
+
# @return [Array<(AclEntryResponse, Integer, Hash)>] AclEntryResponse data, response status code and response headers
|
|
114
|
+
def create_acl_entry_with_http_info(opts = {})
|
|
115
|
+
if @api_client.config.debugging
|
|
116
|
+
@api_client.config.logger.debug 'Calling API: AclEntryApi.create_acl_entry ...'
|
|
117
|
+
end
|
|
118
|
+
# unbox the parameters from the hash
|
|
119
|
+
service_id = opts[:'service_id']
|
|
120
|
+
acl_id = opts[:'acl_id']
|
|
121
|
+
# verify the required parameter 'service_id' is set
|
|
122
|
+
if @api_client.config.client_side_validation && service_id.nil?
|
|
123
|
+
fail ArgumentError, "Missing the required parameter 'service_id' when calling AclEntryApi.create_acl_entry"
|
|
124
|
+
end
|
|
125
|
+
# verify the required parameter 'acl_id' is set
|
|
126
|
+
if @api_client.config.client_side_validation && acl_id.nil?
|
|
127
|
+
fail ArgumentError, "Missing the required parameter 'acl_id' when calling AclEntryApi.create_acl_entry"
|
|
128
|
+
end
|
|
129
|
+
# resource path
|
|
130
|
+
local_var_path = '/service/{service_id}/acl/{acl_id}/entry'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'acl_id' + '}', CGI.escape(acl_id.to_s))
|
|
131
|
+
|
|
132
|
+
# query parameters
|
|
133
|
+
query_params = opts[:query_params] || {}
|
|
134
|
+
|
|
135
|
+
# header parameters
|
|
136
|
+
header_params = opts[:header_params] || {}
|
|
137
|
+
# HTTP header 'Accept' (if needed)
|
|
138
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
139
|
+
# HTTP header 'Content-Type'
|
|
140
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
141
|
+
if !content_type.nil?
|
|
142
|
+
header_params['Content-Type'] = content_type
|
|
143
|
+
end
|
|
144
|
+
|
|
145
|
+
# form parameters
|
|
146
|
+
form_params = opts[:form_params] || {}
|
|
147
|
+
|
|
148
|
+
# http body (model)
|
|
149
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'acl_entry'])
|
|
150
|
+
|
|
151
|
+
# return_type
|
|
152
|
+
return_type = opts[:debug_return_type] || 'AclEntryResponse'
|
|
153
|
+
|
|
154
|
+
# auth_names
|
|
155
|
+
auth_names = opts[:debug_auth_names] || ['token']
|
|
156
|
+
|
|
157
|
+
new_options = opts.merge(
|
|
158
|
+
:operation => :"AclEntryApi.create_acl_entry",
|
|
159
|
+
:header_params => header_params,
|
|
160
|
+
:query_params => query_params,
|
|
161
|
+
:form_params => form_params,
|
|
162
|
+
:body => post_body,
|
|
163
|
+
:auth_names => auth_names,
|
|
164
|
+
:return_type => return_type
|
|
165
|
+
)
|
|
166
|
+
|
|
167
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
|
168
|
+
if @api_client.config.debugging
|
|
169
|
+
@api_client.config.logger.debug "API called: AclEntryApi#create_acl_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
170
|
+
end
|
|
171
|
+
return data, status_code, headers
|
|
172
|
+
end
|
|
173
|
+
|
|
97
174
|
# Delete an ACL entry
|
|
98
175
|
# Delete an ACL entry from a specified ACL.
|
|
99
176
|
# @option opts [String] :service_id Alphanumeric string identifying the service. (required)
|
|
@@ -170,5 +247,260 @@ module Fastly
|
|
|
170
247
|
end
|
|
171
248
|
return data, status_code, headers
|
|
172
249
|
end
|
|
250
|
+
|
|
251
|
+
# Describe an ACL entry
|
|
252
|
+
# Retrieve a single ACL entry.
|
|
253
|
+
# @option opts [String] :service_id Alphanumeric string identifying the service. (required)
|
|
254
|
+
# @option opts [String] :acl_id Alphanumeric string identifying a ACL. (required)
|
|
255
|
+
# @option opts [String] :acl_entry_id Alphanumeric string identifying an ACL Entry. (required)
|
|
256
|
+
# @return [AclEntryResponse]
|
|
257
|
+
def get_acl_entry(opts = {})
|
|
258
|
+
data, _status_code, _headers = get_acl_entry_with_http_info(opts)
|
|
259
|
+
data
|
|
260
|
+
end
|
|
261
|
+
|
|
262
|
+
# Describe an ACL entry
|
|
263
|
+
# Retrieve a single ACL entry.
|
|
264
|
+
# @option opts [String] :service_id Alphanumeric string identifying the service. (required)
|
|
265
|
+
# @option opts [String] :acl_id Alphanumeric string identifying a ACL. (required)
|
|
266
|
+
# @option opts [String] :acl_entry_id Alphanumeric string identifying an ACL Entry. (required)
|
|
267
|
+
# @return [Array<(AclEntryResponse, Integer, Hash)>] AclEntryResponse data, response status code and response headers
|
|
268
|
+
def get_acl_entry_with_http_info(opts = {})
|
|
269
|
+
if @api_client.config.debugging
|
|
270
|
+
@api_client.config.logger.debug 'Calling API: AclEntryApi.get_acl_entry ...'
|
|
271
|
+
end
|
|
272
|
+
# unbox the parameters from the hash
|
|
273
|
+
service_id = opts[:'service_id']
|
|
274
|
+
acl_id = opts[:'acl_id']
|
|
275
|
+
acl_entry_id = opts[:'acl_entry_id']
|
|
276
|
+
# verify the required parameter 'service_id' is set
|
|
277
|
+
if @api_client.config.client_side_validation && service_id.nil?
|
|
278
|
+
fail ArgumentError, "Missing the required parameter 'service_id' when calling AclEntryApi.get_acl_entry"
|
|
279
|
+
end
|
|
280
|
+
# verify the required parameter 'acl_id' is set
|
|
281
|
+
if @api_client.config.client_side_validation && acl_id.nil?
|
|
282
|
+
fail ArgumentError, "Missing the required parameter 'acl_id' when calling AclEntryApi.get_acl_entry"
|
|
283
|
+
end
|
|
284
|
+
# verify the required parameter 'acl_entry_id' is set
|
|
285
|
+
if @api_client.config.client_side_validation && acl_entry_id.nil?
|
|
286
|
+
fail ArgumentError, "Missing the required parameter 'acl_entry_id' when calling AclEntryApi.get_acl_entry"
|
|
287
|
+
end
|
|
288
|
+
# resource path
|
|
289
|
+
local_var_path = '/service/{service_id}/acl/{acl_id}/entry/{acl_entry_id}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'acl_id' + '}', CGI.escape(acl_id.to_s)).sub('{' + 'acl_entry_id' + '}', CGI.escape(acl_entry_id.to_s))
|
|
290
|
+
|
|
291
|
+
# query parameters
|
|
292
|
+
query_params = opts[:query_params] || {}
|
|
293
|
+
|
|
294
|
+
# header parameters
|
|
295
|
+
header_params = opts[:header_params] || {}
|
|
296
|
+
# HTTP header 'Accept' (if needed)
|
|
297
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
298
|
+
|
|
299
|
+
# form parameters
|
|
300
|
+
form_params = opts[:form_params] || {}
|
|
301
|
+
|
|
302
|
+
# http body (model)
|
|
303
|
+
post_body = opts[:debug_body]
|
|
304
|
+
|
|
305
|
+
# return_type
|
|
306
|
+
return_type = opts[:debug_return_type] || 'AclEntryResponse'
|
|
307
|
+
|
|
308
|
+
# auth_names
|
|
309
|
+
auth_names = opts[:debug_auth_names] || ['token']
|
|
310
|
+
|
|
311
|
+
new_options = opts.merge(
|
|
312
|
+
:operation => :"AclEntryApi.get_acl_entry",
|
|
313
|
+
:header_params => header_params,
|
|
314
|
+
:query_params => query_params,
|
|
315
|
+
:form_params => form_params,
|
|
316
|
+
:body => post_body,
|
|
317
|
+
:auth_names => auth_names,
|
|
318
|
+
:return_type => return_type
|
|
319
|
+
)
|
|
320
|
+
|
|
321
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
322
|
+
if @api_client.config.debugging
|
|
323
|
+
@api_client.config.logger.debug "API called: AclEntryApi#get_acl_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
324
|
+
end
|
|
325
|
+
return data, status_code, headers
|
|
326
|
+
end
|
|
327
|
+
|
|
328
|
+
# List ACL entries
|
|
329
|
+
# List ACL entries for a specified ACL.
|
|
330
|
+
# @option opts [String] :service_id Alphanumeric string identifying the service. (required)
|
|
331
|
+
# @option opts [String] :acl_id Alphanumeric string identifying a ACL. (required)
|
|
332
|
+
# @option opts [Integer] :page Current page.
|
|
333
|
+
# @option opts [Integer] :per_page Number of records per page. (default to 20)
|
|
334
|
+
# @option opts [String] :sort Field on which to sort. (default to 'created')
|
|
335
|
+
# @option opts [String] :direction Direction in which to sort results. (default to 'ascend')
|
|
336
|
+
# @return [Array<AclEntryResponse>]
|
|
337
|
+
def list_acl_entries(opts = {})
|
|
338
|
+
data, _status_code, _headers = list_acl_entries_with_http_info(opts)
|
|
339
|
+
data
|
|
340
|
+
end
|
|
341
|
+
|
|
342
|
+
# List ACL entries
|
|
343
|
+
# List ACL entries for a specified ACL.
|
|
344
|
+
# @option opts [String] :service_id Alphanumeric string identifying the service. (required)
|
|
345
|
+
# @option opts [String] :acl_id Alphanumeric string identifying a ACL. (required)
|
|
346
|
+
# @option opts [Integer] :page Current page.
|
|
347
|
+
# @option opts [Integer] :per_page Number of records per page. (default to 20)
|
|
348
|
+
# @option opts [String] :sort Field on which to sort. (default to 'created')
|
|
349
|
+
# @option opts [String] :direction Direction in which to sort results. (default to 'ascend')
|
|
350
|
+
# @return [Array<(Array<AclEntryResponse>, Integer, Hash)>] Array<AclEntryResponse> data, response status code and response headers
|
|
351
|
+
def list_acl_entries_with_http_info(opts = {})
|
|
352
|
+
if @api_client.config.debugging
|
|
353
|
+
@api_client.config.logger.debug 'Calling API: AclEntryApi.list_acl_entries ...'
|
|
354
|
+
end
|
|
355
|
+
# unbox the parameters from the hash
|
|
356
|
+
service_id = opts[:'service_id']
|
|
357
|
+
acl_id = opts[:'acl_id']
|
|
358
|
+
# verify the required parameter 'service_id' is set
|
|
359
|
+
if @api_client.config.client_side_validation && service_id.nil?
|
|
360
|
+
fail ArgumentError, "Missing the required parameter 'service_id' when calling AclEntryApi.list_acl_entries"
|
|
361
|
+
end
|
|
362
|
+
# verify the required parameter 'acl_id' is set
|
|
363
|
+
if @api_client.config.client_side_validation && acl_id.nil?
|
|
364
|
+
fail ArgumentError, "Missing the required parameter 'acl_id' when calling AclEntryApi.list_acl_entries"
|
|
365
|
+
end
|
|
366
|
+
if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
|
|
367
|
+
fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AclEntryApi.list_acl_entries, must be smaller than or equal to 100.'
|
|
368
|
+
end
|
|
369
|
+
|
|
370
|
+
if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
|
|
371
|
+
fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling AclEntryApi.list_acl_entries, must be greater than or equal to 1.'
|
|
372
|
+
end
|
|
373
|
+
|
|
374
|
+
allowable_values = ["ascend", "descend"]
|
|
375
|
+
if @api_client.config.client_side_validation && opts[:'direction'] && !allowable_values.include?(opts[:'direction'])
|
|
376
|
+
fail ArgumentError, "invalid value for \"direction\", must be one of #{allowable_values}"
|
|
377
|
+
end
|
|
378
|
+
# resource path
|
|
379
|
+
local_var_path = '/service/{service_id}/acl/{acl_id}/entries'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'acl_id' + '}', CGI.escape(acl_id.to_s))
|
|
380
|
+
|
|
381
|
+
# query parameters
|
|
382
|
+
query_params = opts[:query_params] || {}
|
|
383
|
+
query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
|
|
384
|
+
query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
|
|
385
|
+
query_params[:'sort'] = opts[:'sort'] if !opts[:'sort'].nil?
|
|
386
|
+
query_params[:'direction'] = opts[:'direction'] if !opts[:'direction'].nil?
|
|
387
|
+
|
|
388
|
+
# header parameters
|
|
389
|
+
header_params = opts[:header_params] || {}
|
|
390
|
+
# HTTP header 'Accept' (if needed)
|
|
391
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
392
|
+
|
|
393
|
+
# form parameters
|
|
394
|
+
form_params = opts[:form_params] || {}
|
|
395
|
+
|
|
396
|
+
# http body (model)
|
|
397
|
+
post_body = opts[:debug_body]
|
|
398
|
+
|
|
399
|
+
# return_type
|
|
400
|
+
return_type = opts[:debug_return_type] || 'Array<AclEntryResponse>'
|
|
401
|
+
|
|
402
|
+
# auth_names
|
|
403
|
+
auth_names = opts[:debug_auth_names] || ['token']
|
|
404
|
+
|
|
405
|
+
new_options = opts.merge(
|
|
406
|
+
:operation => :"AclEntryApi.list_acl_entries",
|
|
407
|
+
:header_params => header_params,
|
|
408
|
+
:query_params => query_params,
|
|
409
|
+
:form_params => form_params,
|
|
410
|
+
:body => post_body,
|
|
411
|
+
:auth_names => auth_names,
|
|
412
|
+
:return_type => return_type
|
|
413
|
+
)
|
|
414
|
+
|
|
415
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
|
416
|
+
if @api_client.config.debugging
|
|
417
|
+
@api_client.config.logger.debug "API called: AclEntryApi#list_acl_entries\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
418
|
+
end
|
|
419
|
+
return data, status_code, headers
|
|
420
|
+
end
|
|
421
|
+
|
|
422
|
+
# Update an ACL entry
|
|
423
|
+
# Update an ACL entry for a specified ACL.
|
|
424
|
+
# @option opts [String] :service_id Alphanumeric string identifying the service. (required)
|
|
425
|
+
# @option opts [String] :acl_id Alphanumeric string identifying a ACL. (required)
|
|
426
|
+
# @option opts [String] :acl_entry_id Alphanumeric string identifying an ACL Entry. (required)
|
|
427
|
+
# @option opts [AclEntry] :acl_entry
|
|
428
|
+
# @return [AclEntryResponse]
|
|
429
|
+
def update_acl_entry(opts = {})
|
|
430
|
+
data, _status_code, _headers = update_acl_entry_with_http_info(opts)
|
|
431
|
+
data
|
|
432
|
+
end
|
|
433
|
+
|
|
434
|
+
# Update an ACL entry
|
|
435
|
+
# Update an ACL entry for a specified ACL.
|
|
436
|
+
# @option opts [String] :service_id Alphanumeric string identifying the service. (required)
|
|
437
|
+
# @option opts [String] :acl_id Alphanumeric string identifying a ACL. (required)
|
|
438
|
+
# @option opts [String] :acl_entry_id Alphanumeric string identifying an ACL Entry. (required)
|
|
439
|
+
# @option opts [AclEntry] :acl_entry
|
|
440
|
+
# @return [Array<(AclEntryResponse, Integer, Hash)>] AclEntryResponse data, response status code and response headers
|
|
441
|
+
def update_acl_entry_with_http_info(opts = {})
|
|
442
|
+
if @api_client.config.debugging
|
|
443
|
+
@api_client.config.logger.debug 'Calling API: AclEntryApi.update_acl_entry ...'
|
|
444
|
+
end
|
|
445
|
+
# unbox the parameters from the hash
|
|
446
|
+
service_id = opts[:'service_id']
|
|
447
|
+
acl_id = opts[:'acl_id']
|
|
448
|
+
acl_entry_id = opts[:'acl_entry_id']
|
|
449
|
+
# verify the required parameter 'service_id' is set
|
|
450
|
+
if @api_client.config.client_side_validation && service_id.nil?
|
|
451
|
+
fail ArgumentError, "Missing the required parameter 'service_id' when calling AclEntryApi.update_acl_entry"
|
|
452
|
+
end
|
|
453
|
+
# verify the required parameter 'acl_id' is set
|
|
454
|
+
if @api_client.config.client_side_validation && acl_id.nil?
|
|
455
|
+
fail ArgumentError, "Missing the required parameter 'acl_id' when calling AclEntryApi.update_acl_entry"
|
|
456
|
+
end
|
|
457
|
+
# verify the required parameter 'acl_entry_id' is set
|
|
458
|
+
if @api_client.config.client_side_validation && acl_entry_id.nil?
|
|
459
|
+
fail ArgumentError, "Missing the required parameter 'acl_entry_id' when calling AclEntryApi.update_acl_entry"
|
|
460
|
+
end
|
|
461
|
+
# resource path
|
|
462
|
+
local_var_path = '/service/{service_id}/acl/{acl_id}/entry/{acl_entry_id}'.sub('{' + 'service_id' + '}', CGI.escape(service_id.to_s)).sub('{' + 'acl_id' + '}', CGI.escape(acl_id.to_s)).sub('{' + 'acl_entry_id' + '}', CGI.escape(acl_entry_id.to_s))
|
|
463
|
+
|
|
464
|
+
# query parameters
|
|
465
|
+
query_params = opts[:query_params] || {}
|
|
466
|
+
|
|
467
|
+
# header parameters
|
|
468
|
+
header_params = opts[:header_params] || {}
|
|
469
|
+
# HTTP header 'Accept' (if needed)
|
|
470
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
|
471
|
+
# HTTP header 'Content-Type'
|
|
472
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
|
473
|
+
if !content_type.nil?
|
|
474
|
+
header_params['Content-Type'] = content_type
|
|
475
|
+
end
|
|
476
|
+
|
|
477
|
+
# form parameters
|
|
478
|
+
form_params = opts[:form_params] || {}
|
|
479
|
+
|
|
480
|
+
# http body (model)
|
|
481
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'acl_entry'])
|
|
482
|
+
|
|
483
|
+
# return_type
|
|
484
|
+
return_type = opts[:debug_return_type] || 'AclEntryResponse'
|
|
485
|
+
|
|
486
|
+
# auth_names
|
|
487
|
+
auth_names = opts[:debug_auth_names] || ['token']
|
|
488
|
+
|
|
489
|
+
new_options = opts.merge(
|
|
490
|
+
:operation => :"AclEntryApi.update_acl_entry",
|
|
491
|
+
:header_params => header_params,
|
|
492
|
+
:query_params => query_params,
|
|
493
|
+
:form_params => form_params,
|
|
494
|
+
:body => post_body,
|
|
495
|
+
:auth_names => auth_names,
|
|
496
|
+
:return_type => return_type
|
|
497
|
+
)
|
|
498
|
+
|
|
499
|
+
data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
|
|
500
|
+
if @api_client.config.debugging
|
|
501
|
+
@api_client.config.logger.debug "API called: AclEntryApi#update_acl_entry\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
|
502
|
+
end
|
|
503
|
+
return data, status_code, headers
|
|
504
|
+
end
|
|
173
505
|
end
|
|
174
506
|
end
|