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
@@ -0,0 +1,233 @@
|
|
1
|
+
# Fastly::SecretStoreApi
|
2
|
+
|
3
|
+
|
4
|
+
```ruby
|
5
|
+
require 'fastly'
|
6
|
+
api_instance = Fastly::SecretStoreApi.new
|
7
|
+
```
|
8
|
+
|
9
|
+
## Methods
|
10
|
+
|
11
|
+
| Method | HTTP request | Description |
|
12
|
+
| ------ | ------------ | ----------- |
|
13
|
+
| [**client_key**](SecretStoreApi.md#client_key) | **POST** /resources/stores/secret/client-key | Create new client key |
|
14
|
+
| [**create_secret_store**](SecretStoreApi.md#create_secret_store) | **POST** /resources/stores/secret | Create new secret store |
|
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} | Create secret store by ID |
|
17
|
+
| [**get_secret_stores**](SecretStoreApi.md#get_secret_stores) | **GET** /resources/stores/secret | Get all secret stores |
|
18
|
+
| [**signing_key**](SecretStoreApi.md#signing_key) | **GET** /resources/stores/secret/signing-key | Get public key |
|
19
|
+
|
20
|
+
|
21
|
+
## `client_key()`
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
client_key: <ClientKey> # Create new client key
|
25
|
+
```
|
26
|
+
|
27
|
+
Create a new client key for encrypting secrets locally before uploading.
|
28
|
+
|
29
|
+
### Examples
|
30
|
+
|
31
|
+
```ruby
|
32
|
+
api_instance = Fastly::SecretStoreApi.new
|
33
|
+
|
34
|
+
begin
|
35
|
+
# Create new client key
|
36
|
+
result = api_instance.client_key
|
37
|
+
p result
|
38
|
+
rescue Fastly::ApiError => e
|
39
|
+
puts "Error when calling SecretStoreApi->client_key: #{e}"
|
40
|
+
end
|
41
|
+
```
|
42
|
+
|
43
|
+
### Options
|
44
|
+
|
45
|
+
This endpoint does not need any parameter.
|
46
|
+
|
47
|
+
### Return type
|
48
|
+
|
49
|
+
[**ClientKey**](ClientKey.md)
|
50
|
+
|
51
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
52
|
+
[[Back to README]](../../README.md)
|
53
|
+
## `create_secret_store()`
|
54
|
+
|
55
|
+
```ruby
|
56
|
+
create_secret_store(opts): <SecretStoreResponse> # Create new secret store
|
57
|
+
```
|
58
|
+
|
59
|
+
Create a new secret store.
|
60
|
+
|
61
|
+
### Examples
|
62
|
+
|
63
|
+
```ruby
|
64
|
+
api_instance = Fastly::SecretStoreApi.new
|
65
|
+
opts = {
|
66
|
+
secret_store: Fastly::SecretStore.new, # SecretStore |
|
67
|
+
}
|
68
|
+
|
69
|
+
begin
|
70
|
+
# Create new secret store
|
71
|
+
result = api_instance.create_secret_store(opts)
|
72
|
+
p result
|
73
|
+
rescue Fastly::ApiError => e
|
74
|
+
puts "Error when calling SecretStoreApi->create_secret_store: #{e}"
|
75
|
+
end
|
76
|
+
```
|
77
|
+
|
78
|
+
### Options
|
79
|
+
|
80
|
+
| Name | Type | Description | Notes |
|
81
|
+
| ---- | ---- | ----------- | ----- |
|
82
|
+
| **secret_store** | [**SecretStore**](SecretStore.md) | | [optional] |
|
83
|
+
|
84
|
+
### Return type
|
85
|
+
|
86
|
+
[**SecretStoreResponse**](SecretStoreResponse.md)
|
87
|
+
|
88
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
89
|
+
[[Back to README]](../../README.md)
|
90
|
+
## `delete_secret_store()`
|
91
|
+
|
92
|
+
```ruby
|
93
|
+
delete_secret_store(opts) # Delete secret store
|
94
|
+
```
|
95
|
+
|
96
|
+
Delete a secret store and all of its contents.
|
97
|
+
|
98
|
+
### Examples
|
99
|
+
|
100
|
+
```ruby
|
101
|
+
api_instance = Fastly::SecretStoreApi.new
|
102
|
+
opts = {
|
103
|
+
store_id: 'store_id_example', # String |
|
104
|
+
}
|
105
|
+
|
106
|
+
begin
|
107
|
+
# Delete secret store
|
108
|
+
api_instance.delete_secret_store(opts)
|
109
|
+
rescue Fastly::ApiError => e
|
110
|
+
puts "Error when calling SecretStoreApi->delete_secret_store: #{e}"
|
111
|
+
end
|
112
|
+
```
|
113
|
+
|
114
|
+
### Options
|
115
|
+
|
116
|
+
| Name | Type | Description | Notes |
|
117
|
+
| ---- | ---- | ----------- | ----- |
|
118
|
+
| **store_id** | **String** | | |
|
119
|
+
|
120
|
+
### Return type
|
121
|
+
|
122
|
+
nil (empty response body)
|
123
|
+
|
124
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
125
|
+
[[Back to README]](../../README.md)
|
126
|
+
## `get_secret_store()`
|
127
|
+
|
128
|
+
```ruby
|
129
|
+
get_secret_store(opts): <SecretStoreResponse> # Create secret store by ID
|
130
|
+
```
|
131
|
+
|
132
|
+
Get a secret store by ID.
|
133
|
+
|
134
|
+
### Examples
|
135
|
+
|
136
|
+
```ruby
|
137
|
+
api_instance = Fastly::SecretStoreApi.new
|
138
|
+
opts = {
|
139
|
+
store_id: 'store_id_example', # String |
|
140
|
+
}
|
141
|
+
|
142
|
+
begin
|
143
|
+
# Create secret store by ID
|
144
|
+
result = api_instance.get_secret_store(opts)
|
145
|
+
p result
|
146
|
+
rescue Fastly::ApiError => e
|
147
|
+
puts "Error when calling SecretStoreApi->get_secret_store: #{e}"
|
148
|
+
end
|
149
|
+
```
|
150
|
+
|
151
|
+
### Options
|
152
|
+
|
153
|
+
| Name | Type | Description | Notes |
|
154
|
+
| ---- | ---- | ----------- | ----- |
|
155
|
+
| **store_id** | **String** | | |
|
156
|
+
|
157
|
+
### Return type
|
158
|
+
|
159
|
+
[**SecretStoreResponse**](SecretStoreResponse.md)
|
160
|
+
|
161
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
162
|
+
[[Back to README]](../../README.md)
|
163
|
+
## `get_secret_stores()`
|
164
|
+
|
165
|
+
```ruby
|
166
|
+
get_secret_stores(opts): <InlineResponse2005> # Get all secret stores
|
167
|
+
```
|
168
|
+
|
169
|
+
Get all secret stores.
|
170
|
+
|
171
|
+
### Examples
|
172
|
+
|
173
|
+
```ruby
|
174
|
+
api_instance = Fastly::SecretStoreApi.new
|
175
|
+
opts = {
|
176
|
+
cursor: 'cursor_example', # String | Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty.
|
177
|
+
limit: 'limit_example', # String | Number of results per page. The maximum is 200.
|
178
|
+
}
|
179
|
+
|
180
|
+
begin
|
181
|
+
# Get all secret stores
|
182
|
+
result = api_instance.get_secret_stores(opts)
|
183
|
+
p result
|
184
|
+
rescue Fastly::ApiError => e
|
185
|
+
puts "Error when calling SecretStoreApi->get_secret_stores: #{e}"
|
186
|
+
end
|
187
|
+
```
|
188
|
+
|
189
|
+
### Options
|
190
|
+
|
191
|
+
| Name | Type | Description | Notes |
|
192
|
+
| ---- | ---- | ----------- | ----- |
|
193
|
+
| **cursor** | **String** | Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty. | [optional] |
|
194
|
+
| **limit** | **String** | Number of results per page. The maximum is 200. | [optional][default to '100'] |
|
195
|
+
|
196
|
+
### Return type
|
197
|
+
|
198
|
+
[**InlineResponse2005**](InlineResponse2005.md)
|
199
|
+
|
200
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
201
|
+
[[Back to README]](../../README.md)
|
202
|
+
## `signing_key()`
|
203
|
+
|
204
|
+
```ruby
|
205
|
+
signing_key: <SigningKey> # Get public key
|
206
|
+
```
|
207
|
+
|
208
|
+
Get the public key used for signing client keys.
|
209
|
+
|
210
|
+
### Examples
|
211
|
+
|
212
|
+
```ruby
|
213
|
+
api_instance = Fastly::SecretStoreApi.new
|
214
|
+
|
215
|
+
begin
|
216
|
+
# Get public key
|
217
|
+
result = api_instance.signing_key
|
218
|
+
p result
|
219
|
+
rescue Fastly::ApiError => e
|
220
|
+
puts "Error when calling SecretStoreApi->signing_key: #{e}"
|
221
|
+
end
|
222
|
+
```
|
223
|
+
|
224
|
+
### Options
|
225
|
+
|
226
|
+
This endpoint does not need any parameter.
|
227
|
+
|
228
|
+
### Return type
|
229
|
+
|
230
|
+
[**SigningKey**](SigningKey.md)
|
231
|
+
|
232
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
233
|
+
[[Back to README]](../../README.md)
|
@@ -0,0 +1,255 @@
|
|
1
|
+
# Fastly::SecretStoreItemApi
|
2
|
+
|
3
|
+
|
4
|
+
```ruby
|
5
|
+
require 'fastly'
|
6
|
+
api_instance = Fastly::SecretStoreItemApi.new
|
7
|
+
```
|
8
|
+
|
9
|
+
## Methods
|
10
|
+
|
11
|
+
| Method | HTTP request | Description |
|
12
|
+
| ------ | ------------ | ----------- |
|
13
|
+
| [**create_secret**](SecretStoreItemApi.md#create_secret) | **POST** /resources/stores/secret/{store_id}/secrets | Create a new secret in a store. |
|
14
|
+
| [**delete_secret**](SecretStoreItemApi.md#delete_secret) | **DELETE** /resources/stores/secret/{store_id}/secrets/{secret_name} | Delete a secret from a store. |
|
15
|
+
| [**get_secret**](SecretStoreItemApi.md#get_secret) | **GET** /resources/stores/secret/{store_id}/secrets/{secret_name} | Get secret metadata. |
|
16
|
+
| [**get_secrets**](SecretStoreItemApi.md#get_secrets) | **GET** /resources/stores/secret/{store_id}/secrets | List secrets within a store. |
|
17
|
+
| [**must_recreate_secret**](SecretStoreItemApi.md#must_recreate_secret) | **PATCH** /resources/stores/secret/{store_id}/secrets | Recreate a secret in a store. |
|
18
|
+
| [**recreate_secret**](SecretStoreItemApi.md#recreate_secret) | **PUT** /resources/stores/secret/{store_id}/secrets | Create or recreate a secret in a store. |
|
19
|
+
|
20
|
+
|
21
|
+
## `create_secret()`
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
create_secret(opts): <SecretResponse> # Create a new secret in a store.
|
25
|
+
```
|
26
|
+
|
27
|
+
Create a new secret in a store. Returns an error if a secret already exists with the same name. See `PUT` and `PATCH` methods for ways to recreate an existing secret. The `secret` field must be Base64-encoded because a secret can contain binary data. In the example below, the unencoded secret is \"Hello, world!\"
|
28
|
+
|
29
|
+
### Examples
|
30
|
+
|
31
|
+
```ruby
|
32
|
+
api_instance = Fastly::SecretStoreItemApi.new
|
33
|
+
opts = {
|
34
|
+
store_id: 'store_id_example', # String |
|
35
|
+
secret: Fastly::Secret.new, # Secret |
|
36
|
+
}
|
37
|
+
|
38
|
+
begin
|
39
|
+
# Create a new secret in a store.
|
40
|
+
result = api_instance.create_secret(opts)
|
41
|
+
p result
|
42
|
+
rescue Fastly::ApiError => e
|
43
|
+
puts "Error when calling SecretStoreItemApi->create_secret: #{e}"
|
44
|
+
end
|
45
|
+
```
|
46
|
+
|
47
|
+
### Options
|
48
|
+
|
49
|
+
| Name | Type | Description | Notes |
|
50
|
+
| ---- | ---- | ----------- | ----- |
|
51
|
+
| **store_id** | **String** | | |
|
52
|
+
| **secret** | [**Secret**](Secret.md) | | [optional] |
|
53
|
+
|
54
|
+
### Return type
|
55
|
+
|
56
|
+
[**SecretResponse**](SecretResponse.md)
|
57
|
+
|
58
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
59
|
+
[[Back to README]](../../README.md)
|
60
|
+
## `delete_secret()`
|
61
|
+
|
62
|
+
```ruby
|
63
|
+
delete_secret(opts) # Delete a secret from a store.
|
64
|
+
```
|
65
|
+
|
66
|
+
Delete a secret from a store by name.
|
67
|
+
|
68
|
+
### Examples
|
69
|
+
|
70
|
+
```ruby
|
71
|
+
api_instance = Fastly::SecretStoreItemApi.new
|
72
|
+
opts = {
|
73
|
+
store_id: 'store_id_example', # String |
|
74
|
+
secret_name: 'secret_name_example', # String |
|
75
|
+
}
|
76
|
+
|
77
|
+
begin
|
78
|
+
# Delete a secret from a store.
|
79
|
+
api_instance.delete_secret(opts)
|
80
|
+
rescue Fastly::ApiError => e
|
81
|
+
puts "Error when calling SecretStoreItemApi->delete_secret: #{e}"
|
82
|
+
end
|
83
|
+
```
|
84
|
+
|
85
|
+
### Options
|
86
|
+
|
87
|
+
| Name | Type | Description | Notes |
|
88
|
+
| ---- | ---- | ----------- | ----- |
|
89
|
+
| **store_id** | **String** | | |
|
90
|
+
| **secret_name** | **String** | | |
|
91
|
+
|
92
|
+
### Return type
|
93
|
+
|
94
|
+
nil (empty response body)
|
95
|
+
|
96
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
97
|
+
[[Back to README]](../../README.md)
|
98
|
+
## `get_secret()`
|
99
|
+
|
100
|
+
```ruby
|
101
|
+
get_secret(opts): <SecretResponse> # Get secret metadata.
|
102
|
+
```
|
103
|
+
|
104
|
+
Get metadata about a secret by name.
|
105
|
+
|
106
|
+
### Examples
|
107
|
+
|
108
|
+
```ruby
|
109
|
+
api_instance = Fastly::SecretStoreItemApi.new
|
110
|
+
opts = {
|
111
|
+
store_id: 'store_id_example', # String |
|
112
|
+
secret_name: 'secret_name_example', # String |
|
113
|
+
}
|
114
|
+
|
115
|
+
begin
|
116
|
+
# Get secret metadata.
|
117
|
+
result = api_instance.get_secret(opts)
|
118
|
+
p result
|
119
|
+
rescue Fastly::ApiError => e
|
120
|
+
puts "Error when calling SecretStoreItemApi->get_secret: #{e}"
|
121
|
+
end
|
122
|
+
```
|
123
|
+
|
124
|
+
### Options
|
125
|
+
|
126
|
+
| Name | Type | Description | Notes |
|
127
|
+
| ---- | ---- | ----------- | ----- |
|
128
|
+
| **store_id** | **String** | | |
|
129
|
+
| **secret_name** | **String** | | |
|
130
|
+
|
131
|
+
### Return type
|
132
|
+
|
133
|
+
[**SecretResponse**](SecretResponse.md)
|
134
|
+
|
135
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
136
|
+
[[Back to README]](../../README.md)
|
137
|
+
## `get_secrets()`
|
138
|
+
|
139
|
+
```ruby
|
140
|
+
get_secrets(opts): <InlineResponse2006> # List secrets within a store.
|
141
|
+
```
|
142
|
+
|
143
|
+
List all secrets within a store.
|
144
|
+
|
145
|
+
### Examples
|
146
|
+
|
147
|
+
```ruby
|
148
|
+
api_instance = Fastly::SecretStoreItemApi.new
|
149
|
+
opts = {
|
150
|
+
store_id: 'store_id_example', # String |
|
151
|
+
cursor: 'cursor_example', # String | Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty.
|
152
|
+
limit: 'limit_example', # String | Number of results per page. The maximum is 200.
|
153
|
+
}
|
154
|
+
|
155
|
+
begin
|
156
|
+
# List secrets within a store.
|
157
|
+
result = api_instance.get_secrets(opts)
|
158
|
+
p result
|
159
|
+
rescue Fastly::ApiError => e
|
160
|
+
puts "Error when calling SecretStoreItemApi->get_secrets: #{e}"
|
161
|
+
end
|
162
|
+
```
|
163
|
+
|
164
|
+
### Options
|
165
|
+
|
166
|
+
| Name | Type | Description | Notes |
|
167
|
+
| ---- | ---- | ----------- | ----- |
|
168
|
+
| **store_id** | **String** | | |
|
169
|
+
| **cursor** | **String** | Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty. | [optional] |
|
170
|
+
| **limit** | **String** | Number of results per page. The maximum is 200. | [optional][default to '100'] |
|
171
|
+
|
172
|
+
### Return type
|
173
|
+
|
174
|
+
[**InlineResponse2006**](InlineResponse2006.md)
|
175
|
+
|
176
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
177
|
+
[[Back to README]](../../README.md)
|
178
|
+
## `must_recreate_secret()`
|
179
|
+
|
180
|
+
```ruby
|
181
|
+
must_recreate_secret(opts): <SecretResponse> # Recreate a secret in a store.
|
182
|
+
```
|
183
|
+
|
184
|
+
Recreate a secret based on the secret's name. Returns an error if there is no existing secret with the same name. The `secret` field must be Base64-encoded because a secret can contain binary data. In the example below, the unencoded secret is \"Hello, world!\"
|
185
|
+
|
186
|
+
### Examples
|
187
|
+
|
188
|
+
```ruby
|
189
|
+
api_instance = Fastly::SecretStoreItemApi.new
|
190
|
+
opts = {
|
191
|
+
store_id: 'store_id_example', # String |
|
192
|
+
secret: Fastly::Secret.new, # Secret |
|
193
|
+
}
|
194
|
+
|
195
|
+
begin
|
196
|
+
# Recreate a secret in a store.
|
197
|
+
result = api_instance.must_recreate_secret(opts)
|
198
|
+
p result
|
199
|
+
rescue Fastly::ApiError => e
|
200
|
+
puts "Error when calling SecretStoreItemApi->must_recreate_secret: #{e}"
|
201
|
+
end
|
202
|
+
```
|
203
|
+
|
204
|
+
### Options
|
205
|
+
|
206
|
+
| Name | Type | Description | Notes |
|
207
|
+
| ---- | ---- | ----------- | ----- |
|
208
|
+
| **store_id** | **String** | | |
|
209
|
+
| **secret** | [**Secret**](Secret.md) | | [optional] |
|
210
|
+
|
211
|
+
### Return type
|
212
|
+
|
213
|
+
[**SecretResponse**](SecretResponse.md)
|
214
|
+
|
215
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
216
|
+
[[Back to README]](../../README.md)
|
217
|
+
## `recreate_secret()`
|
218
|
+
|
219
|
+
```ruby
|
220
|
+
recreate_secret(opts): <SecretResponse> # Create or recreate a secret in a store.
|
221
|
+
```
|
222
|
+
|
223
|
+
Create or recreate a secret based on the secret's name. The response object's `recreated` field will be true if the secret was recreated. The `secret` field must be Base64-encoded because a secret can contain binary data. In the example below, the unencoded secret is \"Hello, world!\"
|
224
|
+
|
225
|
+
### Examples
|
226
|
+
|
227
|
+
```ruby
|
228
|
+
api_instance = Fastly::SecretStoreItemApi.new
|
229
|
+
opts = {
|
230
|
+
store_id: 'store_id_example', # String |
|
231
|
+
secret: Fastly::Secret.new, # Secret |
|
232
|
+
}
|
233
|
+
|
234
|
+
begin
|
235
|
+
# Create or recreate a secret in a store.
|
236
|
+
result = api_instance.recreate_secret(opts)
|
237
|
+
p result
|
238
|
+
rescue Fastly::ApiError => e
|
239
|
+
puts "Error when calling SecretStoreItemApi->recreate_secret: #{e}"
|
240
|
+
end
|
241
|
+
```
|
242
|
+
|
243
|
+
### Options
|
244
|
+
|
245
|
+
| Name | Type | Description | Notes |
|
246
|
+
| ---- | ---- | ----------- | ----- |
|
247
|
+
| **store_id** | **String** | | |
|
248
|
+
| **secret** | [**Secret**](Secret.md) | | [optional] |
|
249
|
+
|
250
|
+
### Return type
|
251
|
+
|
252
|
+
[**SecretResponse**](SecretResponse.md)
|
253
|
+
|
254
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
255
|
+
[[Back to README]](../../README.md)
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# Fastly::SecretStoreResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **id** | **String** | ID of the store. | [optional] |
|
8
|
+
| **name** | **String** | A human-readable name for the store. | [optional] |
|
9
|
+
| **created_at** | **Time** | Date and time in ISO 8601 format. | [optional][readonly] |
|
10
|
+
|
11
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
12
|
+
|
@@ -12,9 +12,11 @@ api_instance = Fastly::ServiceAuthorizationsApi.new
|
|
12
12
|
| ------ | ------------ | ----------- |
|
13
13
|
| [**create_service_authorization**](ServiceAuthorizationsApi.md#create_service_authorization) | **POST** /service-authorizations | Create service authorization |
|
14
14
|
| [**delete_service_authorization**](ServiceAuthorizationsApi.md#delete_service_authorization) | **DELETE** /service-authorizations/{service_authorization_id} | Delete service authorization |
|
15
|
+
| [**delete_service_authorization2**](ServiceAuthorizationsApi.md#delete_service_authorization2) | **DELETE** /service-authorizations | Delete service authorizations |
|
15
16
|
| [**list_service_authorization**](ServiceAuthorizationsApi.md#list_service_authorization) | **GET** /service-authorizations | List service authorizations |
|
16
17
|
| [**show_service_authorization**](ServiceAuthorizationsApi.md#show_service_authorization) | **GET** /service-authorizations/{service_authorization_id} | Show service authorization |
|
17
18
|
| [**update_service_authorization**](ServiceAuthorizationsApi.md#update_service_authorization) | **PATCH** /service-authorizations/{service_authorization_id} | Update service authorization |
|
19
|
+
| [**update_service_authorization2**](ServiceAuthorizationsApi.md#update_service_authorization2) | **PATCH** /service-authorizations | Update service authorizations |
|
18
20
|
|
19
21
|
|
20
22
|
## `create_service_authorization()`
|
@@ -88,6 +90,43 @@ end
|
|
88
90
|
|
89
91
|
nil (empty response body)
|
90
92
|
|
93
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
94
|
+
[[Back to README]](../../README.md)
|
95
|
+
## `delete_service_authorization2()`
|
96
|
+
|
97
|
+
```ruby
|
98
|
+
delete_service_authorization2(opts): <InlineResponse2007> # Delete service authorizations
|
99
|
+
```
|
100
|
+
|
101
|
+
Delete service authorizations.
|
102
|
+
|
103
|
+
### Examples
|
104
|
+
|
105
|
+
```ruby
|
106
|
+
api_instance = Fastly::ServiceAuthorizationsApi.new
|
107
|
+
opts = {
|
108
|
+
request_body: { key: 3.56}, # Hash<String, Object> |
|
109
|
+
}
|
110
|
+
|
111
|
+
begin
|
112
|
+
# Delete service authorizations
|
113
|
+
result = api_instance.delete_service_authorization2(opts)
|
114
|
+
p result
|
115
|
+
rescue Fastly::ApiError => e
|
116
|
+
puts "Error when calling ServiceAuthorizationsApi->delete_service_authorization2: #{e}"
|
117
|
+
end
|
118
|
+
```
|
119
|
+
|
120
|
+
### Options
|
121
|
+
|
122
|
+
| Name | Type | Description | Notes |
|
123
|
+
| ---- | ---- | ----------- | ----- |
|
124
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
125
|
+
|
126
|
+
### Return type
|
127
|
+
|
128
|
+
[**InlineResponse2007**](InlineResponse2007.md)
|
129
|
+
|
91
130
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
92
131
|
[[Back to README]](../../README.md)
|
93
132
|
## `list_service_authorization()`
|
@@ -205,3 +244,40 @@ end
|
|
205
244
|
|
206
245
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
207
246
|
[[Back to README]](../../README.md)
|
247
|
+
## `update_service_authorization2()`
|
248
|
+
|
249
|
+
```ruby
|
250
|
+
update_service_authorization2(opts): <ServiceAuthorizationsResponse> # Update service authorizations
|
251
|
+
```
|
252
|
+
|
253
|
+
Update service authorizations.
|
254
|
+
|
255
|
+
### Examples
|
256
|
+
|
257
|
+
```ruby
|
258
|
+
api_instance = Fastly::ServiceAuthorizationsApi.new
|
259
|
+
opts = {
|
260
|
+
request_body: { key: 3.56}, # Hash<String, Object> |
|
261
|
+
}
|
262
|
+
|
263
|
+
begin
|
264
|
+
# Update service authorizations
|
265
|
+
result = api_instance.update_service_authorization2(opts)
|
266
|
+
p result
|
267
|
+
rescue Fastly::ApiError => e
|
268
|
+
puts "Error when calling ServiceAuthorizationsApi->update_service_authorization2: #{e}"
|
269
|
+
end
|
270
|
+
```
|
271
|
+
|
272
|
+
### Options
|
273
|
+
|
274
|
+
| Name | Type | Description | Notes |
|
275
|
+
| ---- | ---- | ----------- | ----- |
|
276
|
+
| **request_body** | [**Hash<String, Object>**](Object.md) | | [optional] |
|
277
|
+
|
278
|
+
### Return type
|
279
|
+
|
280
|
+
[**ServiceAuthorizationsResponse**](ServiceAuthorizationsResponse.md)
|
281
|
+
|
282
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
283
|
+
[[Back to README]](../../README.md)
|
data/docs/SigningKey.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# Fastly::SigningKey
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **signing_key** | **String** | A Base64-encoded Ed25519 public key that can be used to verify signatures of client keys. | [optional] |
|
8
|
+
|
9
|
+
[[Back to API list]](../../README.md#endpoints) [[Back to README]](../../README.md)
|
10
|
+
|
data/docs/SnippetApi.md
CHANGED
@@ -15,6 +15,7 @@ api_instance = Fastly::SnippetApi.new
|
|
15
15
|
| [**get_snippet**](SnippetApi.md#get_snippet) | **GET** /service/{service_id}/version/{version_id}/snippet/{snippet_name} | Get a versioned snippet |
|
16
16
|
| [**get_snippet_dynamic**](SnippetApi.md#get_snippet_dynamic) | **GET** /service/{service_id}/snippet/{snippet_id} | Get a dynamic snippet |
|
17
17
|
| [**list_snippets**](SnippetApi.md#list_snippets) | **GET** /service/{service_id}/version/{version_id}/snippet | List snippets |
|
18
|
+
| [**update_snippet**](SnippetApi.md#update_snippet) | **PUT** /service/{service_id}/version/{version_id}/snippet/{snippet_name} | Update a versioned snippet |
|
18
19
|
| [**update_snippet_dynamic**](SnippetApi.md#update_snippet_dynamic) | **PUT** /service/{service_id}/snippet/{snippet_id} | Update a dynamic snippet |
|
19
20
|
|
20
21
|
|
@@ -225,6 +226,47 @@ end
|
|
225
226
|
|
226
227
|
[**Array<SnippetResponse>**](SnippetResponse.md)
|
227
228
|
|
229
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
230
|
+
[[Back to README]](../../README.md)
|
231
|
+
## `update_snippet()`
|
232
|
+
|
233
|
+
```ruby
|
234
|
+
update_snippet(opts): <SnippetResponse> # Update a versioned snippet
|
235
|
+
```
|
236
|
+
|
237
|
+
Update a specific snippet for a particular service and version.
|
238
|
+
|
239
|
+
### Examples
|
240
|
+
|
241
|
+
```ruby
|
242
|
+
api_instance = Fastly::SnippetApi.new
|
243
|
+
opts = {
|
244
|
+
service_id: 'service_id_example', # String | Alphanumeric string identifying the service.
|
245
|
+
version_id: 56, # Integer | Integer identifying a service version.
|
246
|
+
snippet_name: 'snippet_name_example', # String | The name for the snippet.
|
247
|
+
}
|
248
|
+
|
249
|
+
begin
|
250
|
+
# Update a versioned snippet
|
251
|
+
result = api_instance.update_snippet(opts)
|
252
|
+
p result
|
253
|
+
rescue Fastly::ApiError => e
|
254
|
+
puts "Error when calling SnippetApi->update_snippet: #{e}"
|
255
|
+
end
|
256
|
+
```
|
257
|
+
|
258
|
+
### Options
|
259
|
+
|
260
|
+
| Name | Type | Description | Notes |
|
261
|
+
| ---- | ---- | ----------- | ----- |
|
262
|
+
| **service_id** | **String** | Alphanumeric string identifying the service. | |
|
263
|
+
| **version_id** | **Integer** | Integer identifying a service version. | |
|
264
|
+
| **snippet_name** | **String** | The name for the snippet. | |
|
265
|
+
|
266
|
+
### Return type
|
267
|
+
|
268
|
+
[**SnippetResponse**](SnippetResponse.md)
|
269
|
+
|
228
270
|
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
229
271
|
[[Back to README]](../../README.md)
|
230
272
|
## `update_snippet_dynamic()`
|