fastly 16.1.0 → 17.0.0
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 +58 -0
- data/Gemfile.lock +1 -1
- data/README.md +101 -58
- data/docs/Action.md +11 -0
- data/docs/ActionType.md +9 -0
- data/docs/AgentKey.md +14 -0
- data/docs/AgentKeyMeta.md +10 -0
- data/docs/Backend.md +3 -1
- data/docs/BackendApi.md +12 -4
- data/docs/BackendResponse.md +3 -1
- data/docs/BotManagementRequestUpdateConfiguration.md +10 -0
- data/docs/BotManagementResponseConfiguration.md +10 -0
- data/docs/BotManagementResponseConfigurationConfiguration.md +10 -0
- data/docs/BotManagementResponseConfigure.md +13 -0
- data/docs/ClientSideProtectionApi.md +821 -0
- data/docs/ConditionOperator.md +9 -0
- data/docs/ConditionType.md +9 -0
- data/docs/DdosProtectionApi.md +4 -4
- data/docs/Directive.md +11 -0
- data/docs/DmDomainsApi.md +2 -2
- data/docs/DmRoutingConfigsApi.md +912 -0
- data/docs/DomainOwnershipsApi.md +2 -2
- data/docs/DomainResearchApi.md +2 -2
- data/docs/DraftDiff.md +12 -0
- data/docs/DraftUpdate.md +10 -0
- data/docs/EventsResponse.md +1 -1
- data/docs/HeaderEvent.md +14 -0
- data/docs/InitialVersion.md +12 -0
- data/docs/InitialVersionPath.md +11 -0
- data/docs/InlineResponse20010.md +2 -2
- data/docs/InlineResponse20011.md +2 -2
- data/docs/InlineResponse20012.md +1 -1
- data/docs/InlineResponse20013.md +2 -2
- data/docs/InlineResponse20014.md +2 -1
- data/docs/InlineResponse20015.md +10 -0
- data/docs/InlineResponse20016.md +10 -0
- data/docs/InlineResponse20017.md +11 -0
- data/docs/InlineResponse20018.md +11 -0
- data/docs/InlineResponse20019.md +11 -0
- data/docs/InlineResponse20020.md +11 -0
- data/docs/InlineResponse20021.md +11 -0
- data/docs/InlineResponse20022.md +10 -0
- data/docs/InlineResponse2005.md +2 -2
- data/docs/InlineResponse2006.md +2 -2
- data/docs/InlineResponse2007.md +2 -2
- data/docs/InlineResponse2008.md +2 -1
- data/docs/InlineResponse2009.md +2 -1
- data/docs/InvitationsResponse.md +1 -1
- data/docs/KvStoreApi.md +2 -2
- data/docs/KvStoreItemApi.md +2 -2
- data/docs/KvStoreResponseBodyEnable.md +12 -0
- data/docs/KvStoreResponseCustomer.md +10 -0
- data/docs/KvStoreResponseLinks.md +10 -0
- data/docs/KvStoreResponseLinksLinks.md +10 -0
- data/docs/KvStoreResponseProduct.md +10 -0
- data/docs/KvStoreResponseProductProduct.md +11 -0
- data/docs/LoggingAzureblobApi.md +4 -4
- data/docs/LoggingAzureblobResponse.md +1 -1
- data/docs/LoggingCloudfilesApi.md +4 -4
- data/docs/LoggingCloudfilesResponse.md +1 -1
- data/docs/LoggingDigitaloceanApi.md +4 -4
- data/docs/LoggingDigitaloceanResponse.md +1 -1
- data/docs/LoggingFtpApi.md +4 -4
- data/docs/LoggingFtpResponse.md +1 -1
- data/docs/LoggingGcsApi.md +4 -4
- data/docs/LoggingGcsResponse.md +1 -1
- data/docs/LoggingGenericCommon.md +1 -1
- data/docs/LoggingGenericCommonResponse.md +1 -1
- data/docs/LoggingGenericCommonResponseAllOf.md +1 -1
- data/docs/LoggingHttpsAdditional.md +1 -1
- data/docs/LoggingHttpsApi.md +4 -4
- data/docs/LoggingHttpsResponse.md +1 -1
- data/docs/LoggingOpenstackApi.md +4 -4
- data/docs/LoggingOpenstackResponse.md +1 -1
- data/docs/LoggingS3Api.md +4 -4
- data/docs/LoggingS3Response.md +1 -1
- data/docs/LoggingSftpApi.md +4 -4
- data/docs/LoggingSftpResponse.md +1 -1
- data/docs/LoggingSumologicAdditional.md +1 -1
- data/docs/LoggingSumologicApi.md +4 -4
- data/docs/LoggingSumologicResponse.md +1 -1
- data/docs/LoggingSyslogAdditional.md +1 -1
- data/docs/LoggingSyslogApi.md +4 -4
- data/docs/LoggingSyslogResponse.md +1 -1
- data/docs/MutualAuthenticationsResponse.md +1 -1
- data/docs/NgwafAgentKeysApi.md +55 -0
- data/docs/NgwafSimulateApi.md +61 -0
- data/docs/Notification.md +11 -0
- data/docs/NotificationConfig.md +10 -0
- data/docs/Page.md +17 -0
- data/docs/PageCreate.md +14 -0
- data/docs/PageUpdate.md +14 -0
- data/docs/Pagination.md +1 -1
- data/docs/PaginationMeta.md +4 -4
- data/docs/PaginationMeta1.md +13 -0
- data/docs/PathChange.md +15 -0
- data/docs/PathCreate.md +10 -0
- data/docs/PathResponse.md +14 -0
- data/docs/PathResponseAllOf.md +12 -0
- data/docs/PathUpdate.md +10 -0
- data/docs/PathWithRules.md +11 -0
- data/docs/PathsResponse.md +11 -0
- data/docs/Policy.md +17 -0
- data/docs/PolicyCreate.md +13 -0
- data/docs/PolicyUpdate.md +13 -0
- data/docs/Position.md +11 -0
- data/docs/ProductBotManagementApi.md +78 -0
- data/docs/ProductKvStoreApi.md +115 -0
- data/docs/RealtimeEntry.md +1 -1
- data/docs/RealtimeEntryAggregated.md +34 -3
- data/docs/RealtimeEntryDatacenter.md +345 -0
- data/docs/RealtimeMeasurements.md +34 -3
- data/docs/Report.md +15 -0
- data/docs/RequestBodyForCreate.md +1 -0
- data/docs/RequestBodyForUpdate.md +1 -0
- data/docs/Results.md +34 -3
- data/docs/RoutingConfig.md +11 -0
- data/docs/RoutingConfigCondition.md +13 -0
- data/docs/RoutingConfigResponse.md +16 -0
- data/docs/RoutingConfigResponseAllOf.md +14 -0
- data/docs/RoutingConfigState.md +9 -0
- data/docs/RoutingConfigVersionResponse.md +13 -0
- data/docs/RoutingConfigsResponse.md +11 -0
- data/docs/RuleChange.md +12 -0
- data/docs/RuleCreate.md +12 -0
- data/docs/RuleResponse.md +15 -0
- data/docs/RuleResponseAllOf.md +13 -0
- data/docs/RuleUpdate.md +12 -0
- data/docs/RulesResponse.md +11 -0
- data/docs/Script.md +20 -0
- data/docs/ScriptUpdate.md +12 -0
- data/docs/SecretStoreApi.md +2 -2
- data/docs/SecretStoreItemApi.md +2 -2
- data/docs/SecurityHeader.md +12 -0
- data/docs/ServiceAuthorizationsApi.md +2 -2
- data/docs/ServiceAuthorizationsResponse.md +1 -1
- data/docs/SuccessfulResponseAsObject.md +1 -0
- data/docs/SuccessfulResponseAsObjectAllOf.md +1 -0
- data/docs/TlsActivationsResponse.md +1 -1
- data/docs/TlsBulkCertificatesResponse.md +1 -1
- data/docs/TlsCertificatesResponse.md +1 -1
- data/docs/TlsConfigurationsResponse.md +1 -1
- data/docs/TlsDomainsResponse.md +1 -1
- data/docs/TlsPrivateKeysResponse.md +1 -1
- data/docs/TlsSubscriptionsResponse.md +1 -1
- data/docs/VersionsResponse.md +11 -0
- data/docs/WafSimulateRequest.md +11 -0
- data/docs/WafSimulateResponse.md +11 -0
- data/docs/WafSimulateSignal.md +16 -0
- data/docs/Website.md +14 -0
- data/docs/WebsiteCreate.md +10 -0
- data/docs/WebsiteUpdate.md +10 -0
- data/lib/fastly/api/backend_api.rb +16 -4
- data/lib/fastly/api/client_side_protection_api.rb +1465 -0
- data/lib/fastly/api/ddos_protection_api.rb +6 -6
- data/lib/fastly/api/dm_domains_api.rb +3 -3
- data/lib/fastly/api/dm_routing_configs_api.rb +1596 -0
- data/lib/fastly/api/domain_ownerships_api.rb +3 -3
- data/lib/fastly/api/domain_research_api.rb +3 -3
- data/lib/fastly/api/kv_store_api.rb +3 -3
- data/lib/fastly/api/kv_store_item_api.rb +3 -3
- data/lib/fastly/api/logging_azureblob_api.rb +6 -6
- data/lib/fastly/api/logging_cloudfiles_api.rb +6 -6
- data/lib/fastly/api/logging_digitalocean_api.rb +6 -6
- data/lib/fastly/api/logging_ftp_api.rb +6 -6
- data/lib/fastly/api/logging_gcs_api.rb +6 -6
- data/lib/fastly/api/logging_https_api.rb +4 -4
- data/lib/fastly/api/logging_openstack_api.rb +6 -6
- data/lib/fastly/api/logging_s3_api.rb +6 -6
- data/lib/fastly/api/logging_sftp_api.rb +6 -6
- data/lib/fastly/api/logging_sumologic_api.rb +4 -4
- data/lib/fastly/api/logging_syslog_api.rb +4 -4
- data/lib/fastly/api/ngwaf_agent_keys_api.rb +83 -0
- data/lib/fastly/api/ngwaf_simulate_api.rb +95 -0
- data/lib/fastly/api/product_bot_management_api.rb +133 -0
- data/lib/fastly/api/product_kv_store_api.rb +186 -0
- data/lib/fastly/api/secret_store_api.rb +3 -3
- data/lib/fastly/api/secret_store_item_api.rb +3 -3
- data/lib/fastly/api/service_authorizations_api.rb +3 -3
- data/lib/fastly/configuration.rb +294 -0
- data/lib/fastly/models/action.rb +237 -0
- data/lib/fastly/models/action_type.rb +34 -0
- data/lib/fastly/models/agent_key.rb +283 -0
- data/lib/fastly/models/agent_key_meta.rb +223 -0
- data/lib/fastly/models/backend.rb +24 -2
- data/lib/fastly/models/backend_response.rb +24 -2
- data/lib/fastly/models/bot_management_request_update_configuration.rb +256 -0
- data/lib/fastly/models/bot_management_response_configuration.rb +216 -0
- data/lib/fastly/models/bot_management_response_configuration_configuration.rb +217 -0
- data/lib/fastly/models/bot_management_response_configure.rb +253 -0
- data/lib/fastly/models/condition_operator.rb +37 -0
- data/lib/fastly/models/condition_type.rb +34 -0
- data/lib/fastly/models/directive.rb +229 -0
- data/lib/fastly/models/draft_diff.rb +244 -0
- data/lib/fastly/models/draft_update.rb +218 -0
- data/lib/fastly/models/events_response.rb +1 -1
- data/lib/fastly/models/header_event.rb +252 -0
- data/lib/fastly/models/initial_version.rb +242 -0
- data/lib/fastly/models/initial_version_path.rb +254 -0
- data/lib/fastly/models/inline_response20010.rb +2 -2
- data/lib/fastly/models/inline_response20011.rb +2 -2
- data/lib/fastly/models/inline_response20012.rb +1 -1
- data/lib/fastly/models/inline_response20013.rb +11 -1
- data/lib/fastly/models/inline_response20014.rb +15 -4
- data/lib/fastly/models/inline_response20015.rb +217 -0
- data/lib/fastly/models/inline_response20016.rb +218 -0
- data/lib/fastly/models/inline_response20017.rb +227 -0
- data/lib/fastly/models/inline_response20018.rb +227 -0
- data/lib/fastly/models/inline_response20019.rb +228 -0
- data/lib/fastly/models/inline_response20020.rb +227 -0
- data/lib/fastly/models/inline_response20021.rb +227 -0
- data/lib/fastly/models/inline_response20022.rb +218 -0
- data/lib/fastly/models/inline_response2005.rb +2 -2
- data/lib/fastly/models/inline_response2006.rb +2 -12
- data/lib/fastly/models/inline_response2007.rb +2 -4
- data/lib/fastly/models/inline_response2008.rb +18 -8
- data/lib/fastly/models/inline_response2009.rb +17 -8
- data/lib/fastly/models/invitations_response.rb +1 -1
- data/lib/fastly/models/kv_store_response_body_enable.rb +243 -0
- data/lib/fastly/models/kv_store_response_customer.rb +216 -0
- data/lib/fastly/models/kv_store_response_links.rb +216 -0
- data/lib/fastly/models/kv_store_response_links_links.rb +217 -0
- data/lib/fastly/models/kv_store_response_product.rb +216 -0
- data/lib/fastly/models/kv_store_response_product_product.rb +227 -0
- data/lib/fastly/models/logging_azureblob_response.rb +3 -3
- data/lib/fastly/models/logging_cloudfiles_response.rb +3 -3
- data/lib/fastly/models/logging_digitalocean_response.rb +3 -3
- data/lib/fastly/models/logging_ftp_response.rb +3 -3
- data/lib/fastly/models/logging_gcs_response.rb +3 -3
- data/lib/fastly/models/logging_generic_common.rb +3 -3
- data/lib/fastly/models/logging_generic_common_response.rb +3 -3
- data/lib/fastly/models/logging_generic_common_response_all_of.rb +3 -3
- data/lib/fastly/models/logging_https_additional.rb +1 -1
- data/lib/fastly/models/logging_https_response.rb +1 -1
- data/lib/fastly/models/logging_message_type.rb +1 -1
- data/lib/fastly/models/logging_openstack_response.rb +3 -3
- data/lib/fastly/models/logging_s3_response.rb +3 -3
- data/lib/fastly/models/logging_sftp_response.rb +3 -3
- data/lib/fastly/models/logging_sumologic_additional.rb +1 -1
- data/lib/fastly/models/logging_sumologic_response.rb +1 -1
- data/lib/fastly/models/logging_syslog_additional.rb +1 -1
- data/lib/fastly/models/logging_syslog_response.rb +1 -1
- data/lib/fastly/models/mutual_authentications_response.rb +1 -1
- data/lib/fastly/models/notification.rb +270 -0
- data/lib/fastly/models/notification_config.rb +218 -0
- data/lib/fastly/models/page.rb +289 -0
- data/lib/fastly/models/page_create.rb +266 -0
- data/lib/fastly/models/page_update.rb +256 -0
- data/lib/fastly/models/pagination.rb +1 -1
- data/lib/fastly/models/pagination_meta.rb +30 -55
- data/lib/fastly/models/pagination_meta1.rb +273 -0
- data/lib/fastly/models/path_change.rb +274 -0
- data/lib/fastly/models/path_create.rb +242 -0
- data/lib/fastly/models/path_response.rb +285 -0
- data/lib/fastly/models/path_response_all_of.rb +254 -0
- data/lib/fastly/models/path_update.rb +233 -0
- data/lib/fastly/models/path_with_rules.rb +228 -0
- data/lib/fastly/models/paths_response.rb +228 -0
- data/lib/fastly/models/policy.rb +315 -0
- data/lib/fastly/models/policy_create.rb +289 -0
- data/lib/fastly/models/policy_update.rb +279 -0
- data/lib/fastly/models/position.rb +228 -0
- data/lib/fastly/models/realtime_entry.rb +2 -5
- data/lib/fastly/models/realtime_entry_aggregated.rb +344 -34
- data/lib/fastly/models/realtime_entry_datacenter.rb +3577 -0
- data/lib/fastly/models/realtime_measurements.rb +344 -34
- data/lib/fastly/models/report.rb +261 -0
- data/lib/fastly/models/request_body_for_create.rb +12 -1
- data/lib/fastly/models/request_body_for_update.rb +12 -1
- data/lib/fastly/models/results.rb +341 -31
- data/lib/fastly/models/routing_config.rb +251 -0
- data/lib/fastly/models/routing_config_condition.rb +261 -0
- data/lib/fastly/models/routing_config_response.rb +305 -0
- data/lib/fastly/models/routing_config_response_all_of.rb +274 -0
- data/lib/fastly/models/routing_config_state.rb +36 -0
- data/lib/fastly/models/routing_config_version_response.rb +250 -0
- data/lib/fastly/models/routing_configs_response.rb +228 -0
- data/lib/fastly/models/rule_change.rb +236 -0
- data/lib/fastly/models/rule_create.rb +267 -0
- data/lib/fastly/models/rule_response.rb +279 -0
- data/lib/fastly/models/rule_response_all_of.rb +248 -0
- data/lib/fastly/models/rule_update.rb +252 -0
- data/lib/fastly/models/rules_response.rb +228 -0
- data/lib/fastly/models/script.rb +350 -0
- data/lib/fastly/models/script_update.rb +271 -0
- data/lib/fastly/models/security_header.rb +234 -0
- data/lib/fastly/models/service_authorizations_response.rb +1 -1
- data/lib/fastly/models/successful_response_as_object.rb +12 -1
- data/lib/fastly/models/successful_response_as_object_all_of.rb +12 -1
- data/lib/fastly/models/tls_activations_response.rb +1 -1
- data/lib/fastly/models/tls_bulk_certificates_response.rb +1 -1
- data/lib/fastly/models/tls_certificates_response.rb +1 -1
- data/lib/fastly/models/tls_configurations_response.rb +1 -1
- data/lib/fastly/models/tls_domains_response.rb +1 -1
- data/lib/fastly/models/tls_private_keys_response.rb +1 -1
- data/lib/fastly/models/tls_subscriptions_response.rb +1 -1
- data/lib/fastly/models/versions_response.rb +228 -0
- data/lib/fastly/models/waf_simulate_request.rb +233 -0
- data/lib/fastly/models/waf_simulate_response.rb +240 -0
- data/lib/fastly/models/waf_simulate_signal.rb +344 -0
- data/lib/fastly/models/website.rb +257 -0
- data/lib/fastly/models/website_create.rb +222 -0
- data/lib/fastly/models/website_update.rb +217 -0
- data/lib/fastly/version.rb +1 -1
- data/lib/fastly.rb +77 -0
- data/sig.json +1 -1
- metadata +156 -2
|
@@ -0,0 +1,821 @@
|
|
|
1
|
+
# Fastly::ClientSideProtectionApi
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
```ruby
|
|
5
|
+
require 'fastly'
|
|
6
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
7
|
+
```
|
|
8
|
+
|
|
9
|
+
## Methods
|
|
10
|
+
|
|
11
|
+
> [!NOTE]
|
|
12
|
+
> All URIs are relative to `https://api.fastly.com`
|
|
13
|
+
|
|
14
|
+
Method | HTTP request | Description
|
|
15
|
+
------ | ------------ | -----------
|
|
16
|
+
[**csp_create_page**](ClientSideProtectionApi.md#csp_create_page) | **POST** /client-side-protection/v1/pages | Create page
|
|
17
|
+
[**csp_create_policy**](ClientSideProtectionApi.md#csp_create_policy) | **POST** /client-side-protection/v1/pages/{page_id}/policies | Create policy
|
|
18
|
+
[**csp_create_website**](ClientSideProtectionApi.md#csp_create_website) | **POST** /client-side-protection/v1/websites | Create website
|
|
19
|
+
[**csp_delete_page**](ClientSideProtectionApi.md#csp_delete_page) | **DELETE** /client-side-protection/v1/pages/{page_id} | Delete page
|
|
20
|
+
[**csp_delete_website**](ClientSideProtectionApi.md#csp_delete_website) | **DELETE** /client-side-protection/v1/websites/{website_id} | Delete website
|
|
21
|
+
[**csp_get_page**](ClientSideProtectionApi.md#csp_get_page) | **GET** /client-side-protection/v1/pages/{page_id} | Get page
|
|
22
|
+
[**csp_get_policy**](ClientSideProtectionApi.md#csp_get_policy) | **GET** /client-side-protection/v1/pages/{page_id}/policies/{policy_id} | Get policy
|
|
23
|
+
[**csp_get_script**](ClientSideProtectionApi.md#csp_get_script) | **GET** /client-side-protection/v1/pages/{page_id}/scripts/{script_id} | Get script
|
|
24
|
+
[**csp_get_website**](ClientSideProtectionApi.md#csp_get_website) | **GET** /client-side-protection/v1/websites/{website_id} | Get website
|
|
25
|
+
[**csp_list_header_events**](ClientSideProtectionApi.md#csp_list_header_events) | **GET** /client-side-protection/v1/pages/{page_id}/events | List header events
|
|
26
|
+
[**csp_list_headers**](ClientSideProtectionApi.md#csp_list_headers) | **GET** /client-side-protection/v1/pages/{page_id}/headers | List security headers
|
|
27
|
+
[**csp_list_pages**](ClientSideProtectionApi.md#csp_list_pages) | **GET** /client-side-protection/v1/pages | List pages
|
|
28
|
+
[**csp_list_policies**](ClientSideProtectionApi.md#csp_list_policies) | **GET** /client-side-protection/v1/pages/{page_id}/policies | List policies
|
|
29
|
+
[**csp_list_policy_reports**](ClientSideProtectionApi.md#csp_list_policy_reports) | **GET** /client-side-protection/v1/pages/{page_id}/policies/{policy_id}/reports | List policy reports
|
|
30
|
+
[**csp_list_scripts**](ClientSideProtectionApi.md#csp_list_scripts) | **GET** /client-side-protection/v1/pages/{page_id}/scripts | List scripts
|
|
31
|
+
[**csp_list_websites**](ClientSideProtectionApi.md#csp_list_websites) | **GET** /client-side-protection/v1/websites | List websites
|
|
32
|
+
[**csp_update_page**](ClientSideProtectionApi.md#csp_update_page) | **PATCH** /client-side-protection/v1/pages/{page_id} | Update page
|
|
33
|
+
[**csp_update_policy**](ClientSideProtectionApi.md#csp_update_policy) | **PATCH** /client-side-protection/v1/pages/{page_id}/policies/{policy_id} | Update policy
|
|
34
|
+
[**csp_update_script**](ClientSideProtectionApi.md#csp_update_script) | **PATCH** /client-side-protection/v1/pages/{page_id}/scripts/{script_id} | Update script
|
|
35
|
+
[**csp_update_website**](ClientSideProtectionApi.md#csp_update_website) | **PATCH** /client-side-protection/v1/websites/{website_id} | Update website
|
|
36
|
+
|
|
37
|
+
|
|
38
|
+
## `csp_create_page()`
|
|
39
|
+
|
|
40
|
+
```ruby
|
|
41
|
+
csp_create_page(opts): <Page> # Create page
|
|
42
|
+
```
|
|
43
|
+
|
|
44
|
+
Create a new page for monitoring.
|
|
45
|
+
|
|
46
|
+
### Examples
|
|
47
|
+
|
|
48
|
+
```ruby
|
|
49
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
50
|
+
opts = {
|
|
51
|
+
page_create: Fastly::PageCreate.new({website_id: 'website_id_example', name: 'name_example'}), # PageCreate |
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
begin
|
|
55
|
+
# Create page
|
|
56
|
+
result = api_instance.csp_create_page(opts)
|
|
57
|
+
p result
|
|
58
|
+
rescue Fastly::ApiError => e
|
|
59
|
+
puts "Error when calling ClientSideProtectionApi->csp_create_page: #{e}"
|
|
60
|
+
end
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
### Options
|
|
64
|
+
|
|
65
|
+
| Name | Type | Description | Notes |
|
|
66
|
+
| ---- | ---- | ----------- | ----- |
|
|
67
|
+
| **page_create** | [**PageCreate**](PageCreate.md) | | [optional] |
|
|
68
|
+
|
|
69
|
+
### Return type
|
|
70
|
+
|
|
71
|
+
[**Page**](Page.md)
|
|
72
|
+
|
|
73
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
74
|
+
[[Back to README]](../../README.md)
|
|
75
|
+
## `csp_create_policy()`
|
|
76
|
+
|
|
77
|
+
```ruby
|
|
78
|
+
csp_create_policy(opts): <Policy> # Create policy
|
|
79
|
+
```
|
|
80
|
+
|
|
81
|
+
Create a new Content Security Policy for a page.
|
|
82
|
+
|
|
83
|
+
### Examples
|
|
84
|
+
|
|
85
|
+
```ruby
|
|
86
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
87
|
+
opts = {
|
|
88
|
+
page_id: '3Yl0KhQDlg2OaWtOnLsFDq', # String | Page identifier
|
|
89
|
+
policy_create: Fastly::PolicyCreate.new({name: 'name_example', mode: 'report'}), # PolicyCreate |
|
|
90
|
+
}
|
|
91
|
+
|
|
92
|
+
begin
|
|
93
|
+
# Create policy
|
|
94
|
+
result = api_instance.csp_create_policy(opts)
|
|
95
|
+
p result
|
|
96
|
+
rescue Fastly::ApiError => e
|
|
97
|
+
puts "Error when calling ClientSideProtectionApi->csp_create_policy: #{e}"
|
|
98
|
+
end
|
|
99
|
+
```
|
|
100
|
+
|
|
101
|
+
### Options
|
|
102
|
+
|
|
103
|
+
| Name | Type | Description | Notes |
|
|
104
|
+
| ---- | ---- | ----------- | ----- |
|
|
105
|
+
| **page_id** | **String** | Page identifier | |
|
|
106
|
+
| **policy_create** | [**PolicyCreate**](PolicyCreate.md) | | [optional] |
|
|
107
|
+
|
|
108
|
+
### Return type
|
|
109
|
+
|
|
110
|
+
[**Policy**](Policy.md)
|
|
111
|
+
|
|
112
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
113
|
+
[[Back to README]](../../README.md)
|
|
114
|
+
## `csp_create_website()`
|
|
115
|
+
|
|
116
|
+
```ruby
|
|
117
|
+
csp_create_website(opts): <Website> # Create website
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
Create a new website for Client-Side Protection monitoring.
|
|
121
|
+
|
|
122
|
+
### Examples
|
|
123
|
+
|
|
124
|
+
```ruby
|
|
125
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
126
|
+
opts = {
|
|
127
|
+
website_create: Fastly::WebsiteCreate.new({domain: 'domain_example'}), # WebsiteCreate |
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
begin
|
|
131
|
+
# Create website
|
|
132
|
+
result = api_instance.csp_create_website(opts)
|
|
133
|
+
p result
|
|
134
|
+
rescue Fastly::ApiError => e
|
|
135
|
+
puts "Error when calling ClientSideProtectionApi->csp_create_website: #{e}"
|
|
136
|
+
end
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Options
|
|
140
|
+
|
|
141
|
+
| Name | Type | Description | Notes |
|
|
142
|
+
| ---- | ---- | ----------- | ----- |
|
|
143
|
+
| **website_create** | [**WebsiteCreate**](WebsiteCreate.md) | | [optional] |
|
|
144
|
+
|
|
145
|
+
### Return type
|
|
146
|
+
|
|
147
|
+
[**Website**](Website.md)
|
|
148
|
+
|
|
149
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
150
|
+
[[Back to README]](../../README.md)
|
|
151
|
+
## `csp_delete_page()`
|
|
152
|
+
|
|
153
|
+
```ruby
|
|
154
|
+
csp_delete_page(opts) # Delete page
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
Delete a page and all associated scripts and policies.
|
|
158
|
+
|
|
159
|
+
### Examples
|
|
160
|
+
|
|
161
|
+
```ruby
|
|
162
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
163
|
+
opts = {
|
|
164
|
+
page_id: '3Yl0KhQDlg2OaWtOnLsFDq', # String | Page identifier
|
|
165
|
+
}
|
|
166
|
+
|
|
167
|
+
begin
|
|
168
|
+
# Delete page
|
|
169
|
+
api_instance.csp_delete_page(opts)
|
|
170
|
+
rescue Fastly::ApiError => e
|
|
171
|
+
puts "Error when calling ClientSideProtectionApi->csp_delete_page: #{e}"
|
|
172
|
+
end
|
|
173
|
+
```
|
|
174
|
+
|
|
175
|
+
### Options
|
|
176
|
+
|
|
177
|
+
| Name | Type | Description | Notes |
|
|
178
|
+
| ---- | ---- | ----------- | ----- |
|
|
179
|
+
| **page_id** | **String** | Page identifier | |
|
|
180
|
+
|
|
181
|
+
### Return type
|
|
182
|
+
|
|
183
|
+
nil (empty response body)
|
|
184
|
+
|
|
185
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
186
|
+
[[Back to README]](../../README.md)
|
|
187
|
+
## `csp_delete_website()`
|
|
188
|
+
|
|
189
|
+
```ruby
|
|
190
|
+
csp_delete_website(opts) # Delete website
|
|
191
|
+
```
|
|
192
|
+
|
|
193
|
+
Delete a website and all associated pages, scripts, and policies.
|
|
194
|
+
|
|
195
|
+
### Examples
|
|
196
|
+
|
|
197
|
+
```ruby
|
|
198
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
199
|
+
opts = {
|
|
200
|
+
website_id: '2Xk9JgPCkf1NzVsNmKrECp', # String | Website identifier
|
|
201
|
+
}
|
|
202
|
+
|
|
203
|
+
begin
|
|
204
|
+
# Delete website
|
|
205
|
+
api_instance.csp_delete_website(opts)
|
|
206
|
+
rescue Fastly::ApiError => e
|
|
207
|
+
puts "Error when calling ClientSideProtectionApi->csp_delete_website: #{e}"
|
|
208
|
+
end
|
|
209
|
+
```
|
|
210
|
+
|
|
211
|
+
### Options
|
|
212
|
+
|
|
213
|
+
| Name | Type | Description | Notes |
|
|
214
|
+
| ---- | ---- | ----------- | ----- |
|
|
215
|
+
| **website_id** | **String** | Website identifier | |
|
|
216
|
+
|
|
217
|
+
### Return type
|
|
218
|
+
|
|
219
|
+
nil (empty response body)
|
|
220
|
+
|
|
221
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
222
|
+
[[Back to README]](../../README.md)
|
|
223
|
+
## `csp_get_page()`
|
|
224
|
+
|
|
225
|
+
```ruby
|
|
226
|
+
csp_get_page(opts): <Page> # Get page
|
|
227
|
+
```
|
|
228
|
+
|
|
229
|
+
Get details for a specific page.
|
|
230
|
+
|
|
231
|
+
### Examples
|
|
232
|
+
|
|
233
|
+
```ruby
|
|
234
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
235
|
+
opts = {
|
|
236
|
+
page_id: '3Yl0KhQDlg2OaWtOnLsFDq', # String | Page identifier
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
begin
|
|
240
|
+
# Get page
|
|
241
|
+
result = api_instance.csp_get_page(opts)
|
|
242
|
+
p result
|
|
243
|
+
rescue Fastly::ApiError => e
|
|
244
|
+
puts "Error when calling ClientSideProtectionApi->csp_get_page: #{e}"
|
|
245
|
+
end
|
|
246
|
+
```
|
|
247
|
+
|
|
248
|
+
### Options
|
|
249
|
+
|
|
250
|
+
| Name | Type | Description | Notes |
|
|
251
|
+
| ---- | ---- | ----------- | ----- |
|
|
252
|
+
| **page_id** | **String** | Page identifier | |
|
|
253
|
+
|
|
254
|
+
### Return type
|
|
255
|
+
|
|
256
|
+
[**Page**](Page.md)
|
|
257
|
+
|
|
258
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
259
|
+
[[Back to README]](../../README.md)
|
|
260
|
+
## `csp_get_policy()`
|
|
261
|
+
|
|
262
|
+
```ruby
|
|
263
|
+
csp_get_policy(opts): <Policy> # Get policy
|
|
264
|
+
```
|
|
265
|
+
|
|
266
|
+
Get details for a specific policy.
|
|
267
|
+
|
|
268
|
+
### Examples
|
|
269
|
+
|
|
270
|
+
```ruby
|
|
271
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
272
|
+
opts = {
|
|
273
|
+
page_id: '3Yl0KhQDlg2OaWtOnLsFDq', # String | Page identifier
|
|
274
|
+
policy_id: '7Cp4OlUHqj6SfAwSrQwJHu', # String | Policy identifier
|
|
275
|
+
}
|
|
276
|
+
|
|
277
|
+
begin
|
|
278
|
+
# Get policy
|
|
279
|
+
result = api_instance.csp_get_policy(opts)
|
|
280
|
+
p result
|
|
281
|
+
rescue Fastly::ApiError => e
|
|
282
|
+
puts "Error when calling ClientSideProtectionApi->csp_get_policy: #{e}"
|
|
283
|
+
end
|
|
284
|
+
```
|
|
285
|
+
|
|
286
|
+
### Options
|
|
287
|
+
|
|
288
|
+
| Name | Type | Description | Notes |
|
|
289
|
+
| ---- | ---- | ----------- | ----- |
|
|
290
|
+
| **page_id** | **String** | Page identifier | |
|
|
291
|
+
| **policy_id** | **String** | Policy identifier | |
|
|
292
|
+
|
|
293
|
+
### Return type
|
|
294
|
+
|
|
295
|
+
[**Policy**](Policy.md)
|
|
296
|
+
|
|
297
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
298
|
+
[[Back to README]](../../README.md)
|
|
299
|
+
## `csp_get_script()`
|
|
300
|
+
|
|
301
|
+
```ruby
|
|
302
|
+
csp_get_script(opts): <Script> # Get script
|
|
303
|
+
```
|
|
304
|
+
|
|
305
|
+
Get details for a specific script.
|
|
306
|
+
|
|
307
|
+
### Examples
|
|
308
|
+
|
|
309
|
+
```ruby
|
|
310
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
311
|
+
opts = {
|
|
312
|
+
page_id: '3Yl0KhQDlg2OaWtOnLsFDq', # String | Page identifier
|
|
313
|
+
script_id: '5An2MjSFoh4QcYvQpNuHFs', # String | Script identifier
|
|
314
|
+
}
|
|
315
|
+
|
|
316
|
+
begin
|
|
317
|
+
# Get script
|
|
318
|
+
result = api_instance.csp_get_script(opts)
|
|
319
|
+
p result
|
|
320
|
+
rescue Fastly::ApiError => e
|
|
321
|
+
puts "Error when calling ClientSideProtectionApi->csp_get_script: #{e}"
|
|
322
|
+
end
|
|
323
|
+
```
|
|
324
|
+
|
|
325
|
+
### Options
|
|
326
|
+
|
|
327
|
+
| Name | Type | Description | Notes |
|
|
328
|
+
| ---- | ---- | ----------- | ----- |
|
|
329
|
+
| **page_id** | **String** | Page identifier | |
|
|
330
|
+
| **script_id** | **String** | Script identifier | |
|
|
331
|
+
|
|
332
|
+
### Return type
|
|
333
|
+
|
|
334
|
+
[**Script**](Script.md)
|
|
335
|
+
|
|
336
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
337
|
+
[[Back to README]](../../README.md)
|
|
338
|
+
## `csp_get_website()`
|
|
339
|
+
|
|
340
|
+
```ruby
|
|
341
|
+
csp_get_website(opts): <Website> # Get website
|
|
342
|
+
```
|
|
343
|
+
|
|
344
|
+
Get details for a specific website.
|
|
345
|
+
|
|
346
|
+
### Examples
|
|
347
|
+
|
|
348
|
+
```ruby
|
|
349
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
350
|
+
opts = {
|
|
351
|
+
website_id: '2Xk9JgPCkf1NzVsNmKrECp', # String | Website identifier
|
|
352
|
+
}
|
|
353
|
+
|
|
354
|
+
begin
|
|
355
|
+
# Get website
|
|
356
|
+
result = api_instance.csp_get_website(opts)
|
|
357
|
+
p result
|
|
358
|
+
rescue Fastly::ApiError => e
|
|
359
|
+
puts "Error when calling ClientSideProtectionApi->csp_get_website: #{e}"
|
|
360
|
+
end
|
|
361
|
+
```
|
|
362
|
+
|
|
363
|
+
### Options
|
|
364
|
+
|
|
365
|
+
| Name | Type | Description | Notes |
|
|
366
|
+
| ---- | ---- | ----------- | ----- |
|
|
367
|
+
| **website_id** | **String** | Website identifier | |
|
|
368
|
+
|
|
369
|
+
### Return type
|
|
370
|
+
|
|
371
|
+
[**Website**](Website.md)
|
|
372
|
+
|
|
373
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
374
|
+
[[Back to README]](../../README.md)
|
|
375
|
+
## `csp_list_header_events()`
|
|
376
|
+
|
|
377
|
+
```ruby
|
|
378
|
+
csp_list_header_events(opts): <InlineResponse20011> # List header events
|
|
379
|
+
```
|
|
380
|
+
|
|
381
|
+
List security header change events for a page.
|
|
382
|
+
|
|
383
|
+
### Examples
|
|
384
|
+
|
|
385
|
+
```ruby
|
|
386
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
387
|
+
opts = {
|
|
388
|
+
page_id: '3Yl0KhQDlg2OaWtOnLsFDq', # String | Page identifier
|
|
389
|
+
limit: 100, # Integer | Limit how many results are returned.
|
|
390
|
+
page: 1, # Integer | Page number of the collection to request.
|
|
391
|
+
}
|
|
392
|
+
|
|
393
|
+
begin
|
|
394
|
+
# List header events
|
|
395
|
+
result = api_instance.csp_list_header_events(opts)
|
|
396
|
+
p result
|
|
397
|
+
rescue Fastly::ApiError => e
|
|
398
|
+
puts "Error when calling ClientSideProtectionApi->csp_list_header_events: #{e}"
|
|
399
|
+
end
|
|
400
|
+
```
|
|
401
|
+
|
|
402
|
+
### Options
|
|
403
|
+
|
|
404
|
+
| Name | Type | Description | Notes |
|
|
405
|
+
| ---- | ---- | ----------- | ----- |
|
|
406
|
+
| **page_id** | **String** | Page identifier | |
|
|
407
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 100] |
|
|
408
|
+
| **page** | **Integer** | Page number of the collection to request. | [optional][default to 0] |
|
|
409
|
+
|
|
410
|
+
### Return type
|
|
411
|
+
|
|
412
|
+
[**InlineResponse20011**](InlineResponse20011.md)
|
|
413
|
+
|
|
414
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
415
|
+
[[Back to README]](../../README.md)
|
|
416
|
+
## `csp_list_headers()`
|
|
417
|
+
|
|
418
|
+
```ruby
|
|
419
|
+
csp_list_headers(opts): <InlineResponse20010> # List security headers
|
|
420
|
+
```
|
|
421
|
+
|
|
422
|
+
List security headers detected on a page.
|
|
423
|
+
|
|
424
|
+
### Examples
|
|
425
|
+
|
|
426
|
+
```ruby
|
|
427
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
428
|
+
opts = {
|
|
429
|
+
page_id: '3Yl0KhQDlg2OaWtOnLsFDq', # String | Page identifier
|
|
430
|
+
limit: 100, # Integer | Limit how many results are returned.
|
|
431
|
+
page: 1, # Integer | Page number of the collection to request.
|
|
432
|
+
}
|
|
433
|
+
|
|
434
|
+
begin
|
|
435
|
+
# List security headers
|
|
436
|
+
result = api_instance.csp_list_headers(opts)
|
|
437
|
+
p result
|
|
438
|
+
rescue Fastly::ApiError => e
|
|
439
|
+
puts "Error when calling ClientSideProtectionApi->csp_list_headers: #{e}"
|
|
440
|
+
end
|
|
441
|
+
```
|
|
442
|
+
|
|
443
|
+
### Options
|
|
444
|
+
|
|
445
|
+
| Name | Type | Description | Notes |
|
|
446
|
+
| ---- | ---- | ----------- | ----- |
|
|
447
|
+
| **page_id** | **String** | Page identifier | |
|
|
448
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 100] |
|
|
449
|
+
| **page** | **Integer** | Page number of the collection to request. | [optional][default to 0] |
|
|
450
|
+
|
|
451
|
+
### Return type
|
|
452
|
+
|
|
453
|
+
[**InlineResponse20010**](InlineResponse20010.md)
|
|
454
|
+
|
|
455
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
456
|
+
[[Back to README]](../../README.md)
|
|
457
|
+
## `csp_list_pages()`
|
|
458
|
+
|
|
459
|
+
```ruby
|
|
460
|
+
csp_list_pages(opts): <InlineResponse2006> # List pages
|
|
461
|
+
```
|
|
462
|
+
|
|
463
|
+
List all pages. Optionally filter by website.
|
|
464
|
+
|
|
465
|
+
### Examples
|
|
466
|
+
|
|
467
|
+
```ruby
|
|
468
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
469
|
+
opts = {
|
|
470
|
+
website_id: 'website_id_example', # String | Filter pages by website ID
|
|
471
|
+
limit: 100, # Integer | Limit how many results are returned.
|
|
472
|
+
page: 1, # Integer | Page number of the collection to request.
|
|
473
|
+
}
|
|
474
|
+
|
|
475
|
+
begin
|
|
476
|
+
# List pages
|
|
477
|
+
result = api_instance.csp_list_pages(opts)
|
|
478
|
+
p result
|
|
479
|
+
rescue Fastly::ApiError => e
|
|
480
|
+
puts "Error when calling ClientSideProtectionApi->csp_list_pages: #{e}"
|
|
481
|
+
end
|
|
482
|
+
```
|
|
483
|
+
|
|
484
|
+
### Options
|
|
485
|
+
|
|
486
|
+
| Name | Type | Description | Notes |
|
|
487
|
+
| ---- | ---- | ----------- | ----- |
|
|
488
|
+
| **website_id** | **String** | Filter pages by website ID | [optional] |
|
|
489
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 100] |
|
|
490
|
+
| **page** | **Integer** | Page number of the collection to request. | [optional][default to 0] |
|
|
491
|
+
|
|
492
|
+
### Return type
|
|
493
|
+
|
|
494
|
+
[**InlineResponse2006**](InlineResponse2006.md)
|
|
495
|
+
|
|
496
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
497
|
+
[[Back to README]](../../README.md)
|
|
498
|
+
## `csp_list_policies()`
|
|
499
|
+
|
|
500
|
+
```ruby
|
|
501
|
+
csp_list_policies(opts): <InlineResponse2008> # List policies
|
|
502
|
+
```
|
|
503
|
+
|
|
504
|
+
List all Content Security Policies for a page.
|
|
505
|
+
|
|
506
|
+
### Examples
|
|
507
|
+
|
|
508
|
+
```ruby
|
|
509
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
510
|
+
opts = {
|
|
511
|
+
page_id: '3Yl0KhQDlg2OaWtOnLsFDq', # String | Page identifier
|
|
512
|
+
limit: 100, # Integer | Limit how many results are returned.
|
|
513
|
+
page: 1, # Integer | Page number of the collection to request.
|
|
514
|
+
}
|
|
515
|
+
|
|
516
|
+
begin
|
|
517
|
+
# List policies
|
|
518
|
+
result = api_instance.csp_list_policies(opts)
|
|
519
|
+
p result
|
|
520
|
+
rescue Fastly::ApiError => e
|
|
521
|
+
puts "Error when calling ClientSideProtectionApi->csp_list_policies: #{e}"
|
|
522
|
+
end
|
|
523
|
+
```
|
|
524
|
+
|
|
525
|
+
### Options
|
|
526
|
+
|
|
527
|
+
| Name | Type | Description | Notes |
|
|
528
|
+
| ---- | ---- | ----------- | ----- |
|
|
529
|
+
| **page_id** | **String** | Page identifier | |
|
|
530
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 100] |
|
|
531
|
+
| **page** | **Integer** | Page number of the collection to request. | [optional][default to 0] |
|
|
532
|
+
|
|
533
|
+
### Return type
|
|
534
|
+
|
|
535
|
+
[**InlineResponse2008**](InlineResponse2008.md)
|
|
536
|
+
|
|
537
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
538
|
+
[[Back to README]](../../README.md)
|
|
539
|
+
## `csp_list_policy_reports()`
|
|
540
|
+
|
|
541
|
+
```ruby
|
|
542
|
+
csp_list_policy_reports(opts): <InlineResponse2009> # List policy reports
|
|
543
|
+
```
|
|
544
|
+
|
|
545
|
+
List CSP violation reports for a policy.
|
|
546
|
+
|
|
547
|
+
### Examples
|
|
548
|
+
|
|
549
|
+
```ruby
|
|
550
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
551
|
+
opts = {
|
|
552
|
+
page_id: '3Yl0KhQDlg2OaWtOnLsFDq', # String | Page identifier
|
|
553
|
+
policy_id: '7Cp4OlUHqj6SfAwSrQwJHu', # String | Policy identifier
|
|
554
|
+
limit: 100, # Integer | Limit how many results are returned.
|
|
555
|
+
page: 1, # Integer | Page number of the collection to request.
|
|
556
|
+
}
|
|
557
|
+
|
|
558
|
+
begin
|
|
559
|
+
# List policy reports
|
|
560
|
+
result = api_instance.csp_list_policy_reports(opts)
|
|
561
|
+
p result
|
|
562
|
+
rescue Fastly::ApiError => e
|
|
563
|
+
puts "Error when calling ClientSideProtectionApi->csp_list_policy_reports: #{e}"
|
|
564
|
+
end
|
|
565
|
+
```
|
|
566
|
+
|
|
567
|
+
### Options
|
|
568
|
+
|
|
569
|
+
| Name | Type | Description | Notes |
|
|
570
|
+
| ---- | ---- | ----------- | ----- |
|
|
571
|
+
| **page_id** | **String** | Page identifier | |
|
|
572
|
+
| **policy_id** | **String** | Policy identifier | |
|
|
573
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 100] |
|
|
574
|
+
| **page** | **Integer** | Page number of the collection to request. | [optional][default to 0] |
|
|
575
|
+
|
|
576
|
+
### Return type
|
|
577
|
+
|
|
578
|
+
[**InlineResponse2009**](InlineResponse2009.md)
|
|
579
|
+
|
|
580
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
581
|
+
[[Back to README]](../../README.md)
|
|
582
|
+
## `csp_list_scripts()`
|
|
583
|
+
|
|
584
|
+
```ruby
|
|
585
|
+
csp_list_scripts(opts): <InlineResponse2007> # List scripts
|
|
586
|
+
```
|
|
587
|
+
|
|
588
|
+
List all scripts detected on a page.
|
|
589
|
+
|
|
590
|
+
### Examples
|
|
591
|
+
|
|
592
|
+
```ruby
|
|
593
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
594
|
+
opts = {
|
|
595
|
+
page_id: '3Yl0KhQDlg2OaWtOnLsFDq', # String | Page identifier
|
|
596
|
+
limit: 100, # Integer | Limit how many results are returned.
|
|
597
|
+
page: 1, # Integer | Page number of the collection to request.
|
|
598
|
+
}
|
|
599
|
+
|
|
600
|
+
begin
|
|
601
|
+
# List scripts
|
|
602
|
+
result = api_instance.csp_list_scripts(opts)
|
|
603
|
+
p result
|
|
604
|
+
rescue Fastly::ApiError => e
|
|
605
|
+
puts "Error when calling ClientSideProtectionApi->csp_list_scripts: #{e}"
|
|
606
|
+
end
|
|
607
|
+
```
|
|
608
|
+
|
|
609
|
+
### Options
|
|
610
|
+
|
|
611
|
+
| Name | Type | Description | Notes |
|
|
612
|
+
| ---- | ---- | ----------- | ----- |
|
|
613
|
+
| **page_id** | **String** | Page identifier | |
|
|
614
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 100] |
|
|
615
|
+
| **page** | **Integer** | Page number of the collection to request. | [optional][default to 0] |
|
|
616
|
+
|
|
617
|
+
### Return type
|
|
618
|
+
|
|
619
|
+
[**InlineResponse2007**](InlineResponse2007.md)
|
|
620
|
+
|
|
621
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
622
|
+
[[Back to README]](../../README.md)
|
|
623
|
+
## `csp_list_websites()`
|
|
624
|
+
|
|
625
|
+
```ruby
|
|
626
|
+
csp_list_websites(opts): <InlineResponse2005> # List websites
|
|
627
|
+
```
|
|
628
|
+
|
|
629
|
+
List all websites configured for Client-Side Protection.
|
|
630
|
+
|
|
631
|
+
### Examples
|
|
632
|
+
|
|
633
|
+
```ruby
|
|
634
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
635
|
+
opts = {
|
|
636
|
+
limit: 100, # Integer | Limit how many results are returned.
|
|
637
|
+
page: 1, # Integer | Page number of the collection to request.
|
|
638
|
+
}
|
|
639
|
+
|
|
640
|
+
begin
|
|
641
|
+
# List websites
|
|
642
|
+
result = api_instance.csp_list_websites(opts)
|
|
643
|
+
p result
|
|
644
|
+
rescue Fastly::ApiError => e
|
|
645
|
+
puts "Error when calling ClientSideProtectionApi->csp_list_websites: #{e}"
|
|
646
|
+
end
|
|
647
|
+
```
|
|
648
|
+
|
|
649
|
+
### Options
|
|
650
|
+
|
|
651
|
+
| Name | Type | Description | Notes |
|
|
652
|
+
| ---- | ---- | ----------- | ----- |
|
|
653
|
+
| **limit** | **Integer** | Limit how many results are returned. | [optional][default to 100] |
|
|
654
|
+
| **page** | **Integer** | Page number of the collection to request. | [optional][default to 0] |
|
|
655
|
+
|
|
656
|
+
### Return type
|
|
657
|
+
|
|
658
|
+
[**InlineResponse2005**](InlineResponse2005.md)
|
|
659
|
+
|
|
660
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
661
|
+
[[Back to README]](../../README.md)
|
|
662
|
+
## `csp_update_page()`
|
|
663
|
+
|
|
664
|
+
```ruby
|
|
665
|
+
csp_update_page(opts): <Page> # Update page
|
|
666
|
+
```
|
|
667
|
+
|
|
668
|
+
Update a page's configuration.
|
|
669
|
+
|
|
670
|
+
### Examples
|
|
671
|
+
|
|
672
|
+
```ruby
|
|
673
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
674
|
+
opts = {
|
|
675
|
+
page_id: '3Yl0KhQDlg2OaWtOnLsFDq', # String | Page identifier
|
|
676
|
+
page_update: Fastly::PageUpdate.new, # PageUpdate |
|
|
677
|
+
}
|
|
678
|
+
|
|
679
|
+
begin
|
|
680
|
+
# Update page
|
|
681
|
+
result = api_instance.csp_update_page(opts)
|
|
682
|
+
p result
|
|
683
|
+
rescue Fastly::ApiError => e
|
|
684
|
+
puts "Error when calling ClientSideProtectionApi->csp_update_page: #{e}"
|
|
685
|
+
end
|
|
686
|
+
```
|
|
687
|
+
|
|
688
|
+
### Options
|
|
689
|
+
|
|
690
|
+
| Name | Type | Description | Notes |
|
|
691
|
+
| ---- | ---- | ----------- | ----- |
|
|
692
|
+
| **page_id** | **String** | Page identifier | |
|
|
693
|
+
| **page_update** | [**PageUpdate**](PageUpdate.md) | | [optional] |
|
|
694
|
+
|
|
695
|
+
### Return type
|
|
696
|
+
|
|
697
|
+
[**Page**](Page.md)
|
|
698
|
+
|
|
699
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
700
|
+
[[Back to README]](../../README.md)
|
|
701
|
+
## `csp_update_policy()`
|
|
702
|
+
|
|
703
|
+
```ruby
|
|
704
|
+
csp_update_policy(opts): <Policy> # Update policy
|
|
705
|
+
```
|
|
706
|
+
|
|
707
|
+
Update a policy's configuration.
|
|
708
|
+
|
|
709
|
+
### Examples
|
|
710
|
+
|
|
711
|
+
```ruby
|
|
712
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
713
|
+
opts = {
|
|
714
|
+
page_id: '3Yl0KhQDlg2OaWtOnLsFDq', # String | Page identifier
|
|
715
|
+
policy_id: '7Cp4OlUHqj6SfAwSrQwJHu', # String | Policy identifier
|
|
716
|
+
policy_update: Fastly::PolicyUpdate.new, # PolicyUpdate |
|
|
717
|
+
}
|
|
718
|
+
|
|
719
|
+
begin
|
|
720
|
+
# Update policy
|
|
721
|
+
result = api_instance.csp_update_policy(opts)
|
|
722
|
+
p result
|
|
723
|
+
rescue Fastly::ApiError => e
|
|
724
|
+
puts "Error when calling ClientSideProtectionApi->csp_update_policy: #{e}"
|
|
725
|
+
end
|
|
726
|
+
```
|
|
727
|
+
|
|
728
|
+
### Options
|
|
729
|
+
|
|
730
|
+
| Name | Type | Description | Notes |
|
|
731
|
+
| ---- | ---- | ----------- | ----- |
|
|
732
|
+
| **page_id** | **String** | Page identifier | |
|
|
733
|
+
| **policy_id** | **String** | Policy identifier | |
|
|
734
|
+
| **policy_update** | [**PolicyUpdate**](PolicyUpdate.md) | | [optional] |
|
|
735
|
+
|
|
736
|
+
### Return type
|
|
737
|
+
|
|
738
|
+
[**Policy**](Policy.md)
|
|
739
|
+
|
|
740
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
741
|
+
[[Back to README]](../../README.md)
|
|
742
|
+
## `csp_update_script()`
|
|
743
|
+
|
|
744
|
+
```ruby
|
|
745
|
+
csp_update_script(opts): <Script> # Update script
|
|
746
|
+
```
|
|
747
|
+
|
|
748
|
+
Update a script's authorization status or justification.
|
|
749
|
+
|
|
750
|
+
### Examples
|
|
751
|
+
|
|
752
|
+
```ruby
|
|
753
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
754
|
+
opts = {
|
|
755
|
+
page_id: '3Yl0KhQDlg2OaWtOnLsFDq', # String | Page identifier
|
|
756
|
+
script_id: '5An2MjSFoh4QcYvQpNuHFs', # String | Script identifier
|
|
757
|
+
script_update: Fastly::ScriptUpdate.new, # ScriptUpdate |
|
|
758
|
+
}
|
|
759
|
+
|
|
760
|
+
begin
|
|
761
|
+
# Update script
|
|
762
|
+
result = api_instance.csp_update_script(opts)
|
|
763
|
+
p result
|
|
764
|
+
rescue Fastly::ApiError => e
|
|
765
|
+
puts "Error when calling ClientSideProtectionApi->csp_update_script: #{e}"
|
|
766
|
+
end
|
|
767
|
+
```
|
|
768
|
+
|
|
769
|
+
### Options
|
|
770
|
+
|
|
771
|
+
| Name | Type | Description | Notes |
|
|
772
|
+
| ---- | ---- | ----------- | ----- |
|
|
773
|
+
| **page_id** | **String** | Page identifier | |
|
|
774
|
+
| **script_id** | **String** | Script identifier | |
|
|
775
|
+
| **script_update** | [**ScriptUpdate**](ScriptUpdate.md) | | [optional] |
|
|
776
|
+
|
|
777
|
+
### Return type
|
|
778
|
+
|
|
779
|
+
[**Script**](Script.md)
|
|
780
|
+
|
|
781
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
782
|
+
[[Back to README]](../../README.md)
|
|
783
|
+
## `csp_update_website()`
|
|
784
|
+
|
|
785
|
+
```ruby
|
|
786
|
+
csp_update_website(opts): <Website> # Update website
|
|
787
|
+
```
|
|
788
|
+
|
|
789
|
+
Update a website's configuration.
|
|
790
|
+
|
|
791
|
+
### Examples
|
|
792
|
+
|
|
793
|
+
```ruby
|
|
794
|
+
api_instance = Fastly::ClientSideProtectionApi.new
|
|
795
|
+
opts = {
|
|
796
|
+
website_id: '2Xk9JgPCkf1NzVsNmKrECp', # String | Website identifier
|
|
797
|
+
website_update: Fastly::WebsiteUpdate.new, # WebsiteUpdate |
|
|
798
|
+
}
|
|
799
|
+
|
|
800
|
+
begin
|
|
801
|
+
# Update website
|
|
802
|
+
result = api_instance.csp_update_website(opts)
|
|
803
|
+
p result
|
|
804
|
+
rescue Fastly::ApiError => e
|
|
805
|
+
puts "Error when calling ClientSideProtectionApi->csp_update_website: #{e}"
|
|
806
|
+
end
|
|
807
|
+
```
|
|
808
|
+
|
|
809
|
+
### Options
|
|
810
|
+
|
|
811
|
+
| Name | Type | Description | Notes |
|
|
812
|
+
| ---- | ---- | ----------- | ----- |
|
|
813
|
+
| **website_id** | **String** | Website identifier | |
|
|
814
|
+
| **website_update** | [**WebsiteUpdate**](WebsiteUpdate.md) | | [optional] |
|
|
815
|
+
|
|
816
|
+
### Return type
|
|
817
|
+
|
|
818
|
+
[**Website**](Website.md)
|
|
819
|
+
|
|
820
|
+
[[Back to top]](#) [[Back to API list]](../../README.md#endpoints)
|
|
821
|
+
[[Back to README]](../../README.md)
|