{"collection":{"info":{"name":"Fastly API","description":"Via the Fastly API you can perform any of the operations that are possible within the management console, including creating services, domains, and backends; and configuring rules or uploading your own application code, as well as perform account operations such as user administration and billing reports.\n\nThe API is organized into collections of endpoints that allow manipulation of objects related to Fastly services and accounts.\n\nFor the most accurate and up-to-date API reference content, visit [developer.fastly.com/reference/api/](https://developer.fastly.com/reference/api/).","schema":"https://schema.getpostman.com/json/collection/v2.1.0/collection.json"},"variable":[{"key":"fastly_url","value":"https://api.fastly.com"},{"key":"customer_id","description":"Alphanumeric string identifying the customer."},{"key":"month","description":"2-digit month."},{"key":"year","description":"4-digit year."},{"key":"invoice_id","description":"Alphanumeric string identifying the invoice."},{"key":"contact_id","description":"An alphanumeric string identifying the customer contact."},{"key":"event_id","description":"Alphanumeric string identifying an event."},{"key":"invitation_id","description":"Alphanumeric string identifying an invitation."},{"key":"service_authorization_id","description":"Alphanumeric string identifying a service authorization."},{"key":"star_id","description":"Alphanumeric string identifying a star."},{"key":"user_id","description":"Alphanumeric string identifying the user."},{"key":"user_login","description":"The login associated with the user (typically, an email address)."},{"key":"acl_id","description":"Alphanumeric string identifying a ACL."},{"key":"service_id","description":"Alphanumeric string identifying the service."},{"key":"acl_entry_id","description":"Alphanumeric string identifying an ACL Entry."},{"key":"version_id","description":"Integer identifying a service version."},{"key":"acl_name","description":"Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace."},{"key":"id","description":""},{"key":"token_id","description":"Alphanumeric string identifying a token."},{"key":"dictionary_id","description":"Alphanumeric string identifying a Dictionary."},{"key":"dictionary_item_key","description":"Item key, maximum 256 characters."},{"key":"dictionary_name","description":"Name for the Dictionary (must start with an alphabetic character and can contain only alphanumeric characters, underscores, and whitespace)."},{"key":"configuration_set_id","description":"Alphanumeric string identifying a WAF configuration set."},{"key":"firewall_id","description":"Alphanumeric string identifying a Firewall."},{"key":"waf_rule_id","description":"Alphanumeric string identifying a WAF rule."},{"key":"update_status_id","description":"Alphanumeric string identifying a WAF update status."},{"key":"backend_name","description":"The name of the backend."},{"key":"director_name","description":"Name for the Director."},{"key":"pool_name","description":"Name for the Pool."},{"key":"pool_id","description":"Alphanumeric string identifying a Pool."},{"key":"server_id","description":"Alphanumeric string identifying a Server."},{"key":"logging_azureblob_name","description":"The name for the real-time logging configuration."},{"key":"logging_bigquery_name","description":"The name for the real-time logging configuration."},{"key":"logging_cloudfiles_name","description":"The name for the real-time logging configuration."},{"key":"logging_datadog_name","description":"The name for the real-time logging configuration."},{"key":"logging_digitalocean_name","description":"The name for the real-time logging configuration."},{"key":"logging_elasticsearch_name","description":"The name for the real-time logging configuration."},{"key":"logging_ftp_name","description":"The name for the real-time logging configuration."},{"key":"logging_gcs_name","description":"The name for the real-time logging configuration."},{"key":"logging_google_pubsub_name","description":"The name for the real-time logging configuration."},{"key":"logging_heroku_name","description":"The name for the real-time logging configuration."},{"key":"logging_honeycomb_name","description":"The name for the real-time logging configuration."},{"key":"logging_https_name","description":"The name for the real-time logging configuration."},{"key":"logging_kafka_name","description":"The name for the real-time logging configuration."},{"key":"logging_kinesis_name","description":"The name for the real-time logging configuration."},{"key":"logging_logentries_name","description":"The name for the real-time logging configuration."},{"key":"logging_loggly_name","description":"The name for the real-time logging configuration."},{"key":"logging_logshuttle_name","description":"The name for the real-time logging configuration."},{"key":"logging_newrelic_name","description":"The name for the real-time logging configuration."},{"key":"logging_openstack_name","description":"The name for the real-time logging configuration."},{"key":"logging_papertrail_name","description":"The name for the real-time logging configuration."},{"key":"logging_s3_name","description":"The name for the real-time logging configuration."},{"key":"logging_scalyr_name","description":"The name for the real-time logging configuration."},{"key":"logging_sftp_name","description":"The name for the real-time logging configuration."},{"key":"logging_splunk_name","description":"The name for the real-time logging configuration."},{"key":"logging_sumologic_name","description":"The name for the real-time logging configuration."},{"key":"logging_syslog_name","description":"The name for the real-time logging configuration."},{"key":"start_timestamp","description":"Timestamp in seconds (Unix epoch time)."},{"key":"max_entries","description":"Maximum number of results to show."},{"key":"field","description":"Name of the stats field."},{"key":"timestamp_in_seconds","description":"Timestamp in seconds (Unix epoch time)."},{"key":"domain_name","description":"The name of the domain or domains associated with this service."},{"key":"healthcheck_name","description":"The name of the healthcheck."},{"key":"tls_configuration_id","description":"Alphanumeric string identifying a TLS configuration."},{"key":"tls_activation_id","description":"Alphanumeric string identifying a TLS activation."},{"key":"tls_certificate_id","description":"Alphanumeric string identifying a TLS certificate."},{"key":"tls_private_key_id","description":"Alphanumeric string identifying a private Key."},{"key":"mutual_authentication_id","description":"Alphanumeric string identifying a mutual authentication."},{"key":"certificate_id","description":"Alphanumeric string identifying a TLS bulk certificate."},{"key":"tls_subscription_id","description":"Alphanumeric string identifying a TLS subscription."},{"key":"tls_authorization_id","description":"Alphanumeric string identifying a TLS subscription."},{"key":"globalsign_email_challenge_id","description":""},{"key":"from_version_id","description":"The version number of the service to which changes in the generated VCL are being compared. Can either be a positive number from 1 to your maximum version or a negative number from -1 down (-1 is latest version etc)."},{"key":"to_version_id","description":"The version number of the service from which changes in the generated VCL are being compared. Uses same numbering scheme as from."},{"key":"subject","description":"The subject to search for. Supports regular expressions."},{"key":"section","description":"The section to search for. Supports regular expressions."},{"key":"apex_redirect_id","description":""},{"key":"cache_settings_name","description":"Name for the cache settings object."},{"key":"condition_name","description":"Name of the condition. Required."},{"key":"gzip_name","description":"Name of the gzip configuration."},{"key":"header_name","description":"A handle to refer to this Header object."},{"key":"rate_limiter_id","description":"Alphanumeric string identifying the rate limiter."},{"key":"request_settings_name","description":"Name for the request settings."},{"key":"response_object_name","description":"Name for the request settings."},{"key":"snippet_id","description":"Alphanumeric string identifying a VCL Snippet."},{"key":"snippet_name","description":"The name for the snippet."},{"key":"vcl_name","description":"The name of this VCL."},{"key":"surrogate_key","description":"Surrogate keys are used to efficiently purge content from cache. Instead of purging your entire site or individual URLs, you can tag related assets (like all images and descriptions associated with a single product) with surrogate keys, and these grouped URLs can be purged in a single request."},{"key":"firewall_version_number","description":"Integer identifying a WAF firewall version."},{"key":"waf_tag_name","description":"Name of the tag."},{"key":"exclusion_number","description":"A numeric ID identifying a WAF exclusion."},{"key":"waf_rule_revision_number","description":"Revision number."}],"item":[{"name":"Account","item":[{"name":"Billing address","description":"A billing address is used to calculate your bill correctly.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| address_1 | string | The first address line. |\n| address_2 | string | The second address line. |\n| city | string | The city name. |\n| country | string | ISO 3166-1 two-letter country code. |\n| customer_id | string | Alphanumeric string identifying the customer. |\n| locality | string | Other locality. |\n| postal_code | string | Postal code (ZIP code for US addresses). |\n| state | string | The state or province name. |\n| type | string | Resource type. |\n| id | string | Alphanumeric string identifying the billing address. |\n| relationships.customer.id | string | Alphanumeric string identifying the customer. |","item":[{"name":"Get a billing address","request":{"name":"Get a billing address","description":"Get a customer's billing address.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/customer/{{customer_id}}/billing_address","path":["customer","{{customer_id}}","billing_address"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"type\":\"billing_address\",\"id\":\"3DTWpamEUGISvrUiDWkesQ\",\"attributes\":{\"address_1\":\"80719 Dorothea Mountain\",\"address_2\":\"Apt. 652\",\"city\":\"New Rasheedville\",\"state\":\"DE\",\"country\":\"US\",\"postal_code\":\"53538-5902\"},\"relationships\":{\"customer\":{\"data\":[{\"type\":\"customer\",\"id\":\"x4xCwxxJxGCx123Rx5xTx\"}]}}}}","originalRequest":{"name":"Get a billing address","description":"Get a customer's billing address.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/billing_address","path":["customer","x4xCwxxJxGCx123Rx5xTx","billing_address"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Add a billing address to a customer","request":{"name":"Add a billing address to a customer","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/billing-address/#add-billing-addr)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"POST","url":{"raw":"{{fastly_url}}/customer/{{customer_id}}/billing_address","path":["customer","{{customer_id}}","billing_address"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"billing_address\",\"attributes\":{\"address_1\":\"80719 Dorothea Mountain\",\"address_2\":\"Apt. 652\",\"city\":\"New Rasheedville\",\"state\":\"DE\",\"country\":\"US\",\"postal_code\":\"53538-5902\"}}}"}},"response":[{"status":"201 Created","name":"201 Created","code":201,"header":[],"body":"{\"data\":{\"type\":\"billing_address\",\"id\":\"3DTWpamEUGISvrUiDWkesQ\",\"attributes\":{\"address_1\":\"80719 Dorothea Mountain\",\"address_2\":\"Apt. 652\",\"city\":\"New Rasheedville\",\"state\":\"DE\",\"country\":\"US\",\"postal_code\":\"53538-5902\"},\"relationships\":{\"customer\":{\"data\":[{\"type\":\"customer\",\"id\":\"x4xCwxxJxGCx123Rx5xTx\"}]}}}}","originalRequest":{"name":"Add a billing address to a customer","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/billing-address/#add-billing-addr)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"POST","url":{"raw":"https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/billing_address","path":["customer","x4xCwxxJxGCx123Rx5xTx","billing_address"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"billing_address\",\"attributes\":{\"address_1\":\"80719 Dorothea Mountain\",\"address_2\":\"Apt. 652\",\"city\":\"New Rasheedville\",\"state\":\"DE\",\"country\":\"US\",\"postal_code\":\"53538-5902\"}}}"}}}]},{"name":"Delete a billing address","request":{"name":"Delete a billing address","description":"Delete a customer's billing address.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"{{fastly_url}}/customer/{{customer_id}}/billing_address","path":["customer","{{customer_id}}","billing_address"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"204 No Content","name":"204 No Content","code":204,"header":[],"originalRequest":{"name":"Delete a billing address","description":"Delete a customer's billing address.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/billing_address","path":["customer","x4xCwxxJxGCx123Rx5xTx","billing_address"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a billing address","request":{"name":"Update a billing address","description":"Update a customer's billing address. You may update only part of the customer's billing address.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PATCH","url":{"raw":"{{fastly_url}}/customer/{{customer_id}}/billing_address","path":["customer","{{customer_id}}","billing_address"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"billing_address\",\"id\":\"3DTWpamEUGISvrUiDWkesQ\",\"attributes\":{\"state\":\"DE\"}}}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"type\":\"billing_address\",\"id\":\"3DTWpamEUGISvrUiDWkesQ\",\"attributes\":{\"address_1\":\"80719 Dorothea Mountain\",\"address_2\":\"Apt. 652\",\"city\":\"New Rasheedville\",\"state\":\"DE\",\"country\":\"US\",\"postal_code\":\"53538-5902\"},\"relationships\":{\"customer\":{\"data\":[{\"type\":\"customer\",\"id\":\"x4xCwxxJxGCx123Rx5xTx\"}]}}}}","originalRequest":{"name":"Update a billing address","description":"Update a customer's billing address. You may update only part of the customer's billing address.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PATCH","url":{"raw":"https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/billing_address","path":["customer","x4xCwxxJxGCx123Rx5xTx","billing_address"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"billing_address\",\"id\":\"3DTWpamEUGISvrUiDWkesQ\",\"attributes\":{\"state\":\"DE\"}}}"}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Billing","description":"Get information on current and past bills.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| customer_id | string | Alphanumeric string identifying the customer. |\n| end_time | string | Date and time in ISO 8601 format. |\n| invoice_id | string | Alphanumeric string identifying the invoice. |\n| regions | object | Breakdown of regional data for products that are region based. |\n| start_time | string | Date and time in ISO 8601 format. |\n| total | object | Complete summary of the billing information. |\n| aria_invoice_id | string | Alphanumeric string identifying the invoice. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"Get an invoice","request":{"name":"Get an invoice","description":"Get the invoice for a given year and month. Can be any month from when the Customer was created to the current month.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/billing/v2/year/{{year}}/month/{{month}}","path":["billing","v2","year","{{year}}","month","{{month}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"customer_id\":\"2sLme2UJR3SksnvKdEXHri\",\"end_time\":\"2020-05-31T23:59:59.000Z\",\"invoice_id\":\"4183280\",\"line_items\":[{\"amount\":0,\"aria_invoice_id\":\"7SlAESxcJ2zxHOV4gQ9y9X\",\"client_service_id\":\"Master_Plan\",\"created_at\":\"2020-04-03T20:27:05.000Z\",\"credit_coupon_code\":null,\"deleted_at\":null,\"description\":\"Master Plan\",\"id\":\"1DcJwU7Jl1cAHtI51qToYL\",\"line_number\":1,\"plan_name\":\"Master Plan - Fastly US - M2M\",\"plan_no\":18842,\"rate_per_unit\":0,\"rate_schedule_no\":339216,\"rate_schedule_tier_no\":1,\"service_name\":\"Master Plan\",\"service_no\":11003478,\"units\":1,\"updated_at\":\"2020-04-03T20:27:05.000Z\",\"usage_type_cd\":null,\"usage_type_no\":null},{\"amount\":50,\"aria_invoice_id\":\"7SlAESxcJ2zxHOV4gQ9y9X\",\"client_service_id\":\"Committed Amount\",\"created_at\":\"2020-04-03T20:27:05.000Z\",\"credit_coupon_code\":null,\"deleted_at\":null,\"description\":\"Monthly Minimum Fee\",\"id\":\"7b8PVTj2KDANeJQYs44FFv\",\"line_number\":2,\"plan_name\":\"CDN\",\"plan_no\":18844,\"rate_per_unit\":50,\"rate_schedule_no\":null,\"rate_schedule_tier_no\":null,\"service_name\":\"Commit Shortfall\",\"service_no\":11003593,\"units\":1,\"updated_at\":\"2020-04-03T20:27:05.000Z\",\"usage_type_cd\":null,\"usage_type_no\":null},{\"amount\":100,\"aria_invoice_id\":\"7SlAESxcJ2zxHOV4gQ9y9X\",\"client_service_id\":\"Shared_TLS_Certificate\",\"created_at\":\"2020-04-03T20:27:05.000Z\",\"credit_coupon_code\":null,\"deleted_at\":null,\"description\":\"Shared TLS Certificate\",\"id\":\"6ExVVQWoHgpHVl9RYl8FJn\",\"line_number\":3,\"plan_name\":\"Shared TLS Certificate\",\"plan_no\":18920,\"rate_per_unit\":100,\"rate_schedule_no\":345595,\"rate_schedule_tier_no\":1,\"service_name\":\"Shared TLS Certificate\",\"service_no\":11003459,\"units\":1,\"updated_at\":\"2020-04-03T20:27:05.000Z\",\"usage_type_cd\":null,\"usage_type_no\":null},{\"amount\":-50,\"aria_invoice_id\":\"7SlAESxcJ2zxHOV4gQ9y9X\",\"client_service_id\":\"Committed Amount\",\"created_at\":\"2020-04-03T20:27:05.000Z\",\"credit_coupon_code\":\"developer\",\"deleted_at\":null,\"description\":\"100% off coupon\",\"id\":\"6b9TYZegr2eKIPxdGIUBdX\",\"line_number\":4,\"plan_name\":\"CDN\",\"plan_no\":18844,\"rate_per_unit\":-50,\"rate_schedule_no\":null,\"rate_schedule_tier_no\":null,\"service_name\":\"Commit Shortfall\",\"service_no\":11003593,\"units\":1,\"updated_at\":\"2020-04-03T20:27:05.000Z\",\"usage_type_cd\":null,\"usage_type_no\":null}],\"regions\":{\"usa\":{\"cost\":14.050722881322,\"bandwidth\":{\"tiers\":[{\"units\":9.23366359435022,\"total\":1.10803963132203,\"price\":0.12,\"name\":\"first 10TB\"}],\"total\":1.10803963132203},\"requests\":{\"tiers\":[{\"units\":0,\"total\":0,\"name\":\"per 10,000 HTTPS requests\",\"price\":0.01},{\"total\":12.94268325,\"units\":1725.6911,\"name\":\"per 10,000 HTTP requests\",\"price\":0.0075}],\"total\":12.94268325}}},\"start_time\":\"2020-05-01T00:00:00.000Z\",\"status\":{\"status\":\"Outstanding\"},\"total\":{\"bandwidth\":0.00027189962565898895,\"bandwidth_cost\":3.2627955079078674e-05,\"bandwidth_units\":\"GB\",\"cost\":0,\"cost_before_discount\":8.302795507907867e-05,\"discount\":100,\"extras\":[{\"name\":\"Shared TLS Certificate\",\"recurring\":100,\"setup\":0}],\"extras_cost\":0,\"incurred_cost\":8.302795507907867e-05,\"plan_code\":\"developer\",\"plan_minimum\":0,\"plan_name\":\"developer\",\"requests\":66,\"requests_cost\":5.039999999999999e-05,\"terms\":\"Net15\"}}","originalRequest":{"name":"Get an invoice","description":"Get the invoice for a given year and month. Can be any month from when the Customer was created to the current month.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/billing/v2/year/2020/month/05","path":["billing","v2","year","2020","month","05"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get an invoice","request":{"name":"Get an invoice","description":"Get the invoice for the given invoice_id.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/billing/v2/account_customers/{{customer_id}}/invoices/{{invoice_id}}","path":["billing","v2","account_customers","{{customer_id}}","invoices","{{invoice_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"customer_id\":\"2sLme2UJR3SksnvKdEXHri\",\"end_time\":\"2020-05-31T23:59:59.000Z\",\"invoice_id\":\"4183280\",\"line_items\":[{\"amount\":0,\"aria_invoice_id\":\"7SlAESxcJ2zxHOV4gQ9y9X\",\"client_service_id\":\"Master_Plan\",\"created_at\":\"2020-04-03T20:27:05.000Z\",\"credit_coupon_code\":null,\"deleted_at\":null,\"description\":\"Master Plan\",\"id\":\"1DcJwU7Jl1cAHtI51qToYL\",\"line_number\":1,\"plan_name\":\"Master Plan - Fastly US - M2M\",\"plan_no\":18842,\"rate_per_unit\":0,\"rate_schedule_no\":339216,\"rate_schedule_tier_no\":1,\"service_name\":\"Master Plan\",\"service_no\":11003478,\"units\":1,\"updated_at\":\"2020-04-03T20:27:05.000Z\",\"usage_type_cd\":null,\"usage_type_no\":null},{\"amount\":50,\"aria_invoice_id\":\"7SlAESxcJ2zxHOV4gQ9y9X\",\"client_service_id\":\"Committed Amount\",\"created_at\":\"2020-04-03T20:27:05.000Z\",\"credit_coupon_code\":null,\"deleted_at\":null,\"description\":\"Monthly Minimum Fee\",\"id\":\"7b8PVTj2KDANeJQYs44FFv\",\"line_number\":2,\"plan_name\":\"CDN\",\"plan_no\":18844,\"rate_per_unit\":50,\"rate_schedule_no\":null,\"rate_schedule_tier_no\":null,\"service_name\":\"Commit Shortfall\",\"service_no\":11003593,\"units\":1,\"updated_at\":\"2020-04-03T20:27:05.000Z\",\"usage_type_cd\":null,\"usage_type_no\":null},{\"amount\":100,\"aria_invoice_id\":\"7SlAESxcJ2zxHOV4gQ9y9X\",\"client_service_id\":\"Shared_TLS_Certificate\",\"created_at\":\"2020-04-03T20:27:05.000Z\",\"credit_coupon_code\":null,\"deleted_at\":null,\"description\":\"Shared TLS Certificate\",\"id\":\"6ExVVQWoHgpHVl9RYl8FJn\",\"line_number\":3,\"plan_name\":\"Shared TLS Certificate\",\"plan_no\":18920,\"rate_per_unit\":100,\"rate_schedule_no\":345595,\"rate_schedule_tier_no\":1,\"service_name\":\"Shared TLS Certificate\",\"service_no\":11003459,\"units\":1,\"updated_at\":\"2020-04-03T20:27:05.000Z\",\"usage_type_cd\":null,\"usage_type_no\":null},{\"amount\":-50,\"aria_invoice_id\":\"7SlAESxcJ2zxHOV4gQ9y9X\",\"client_service_id\":\"Committed Amount\",\"created_at\":\"2020-04-03T20:27:05.000Z\",\"credit_coupon_code\":\"developer\",\"deleted_at\":null,\"description\":\"100% off coupon\",\"id\":\"6b9TYZegr2eKIPxdGIUBdX\",\"line_number\":4,\"plan_name\":\"CDN\",\"plan_no\":18844,\"rate_per_unit\":-50,\"rate_schedule_no\":null,\"rate_schedule_tier_no\":null,\"service_name\":\"Commit Shortfall\",\"service_no\":11003593,\"units\":1,\"updated_at\":\"2020-04-03T20:27:05.000Z\",\"usage_type_cd\":null,\"usage_type_no\":null}],\"regions\":{\"usa\":{\"cost\":14.050722881322,\"bandwidth\":{\"tiers\":[{\"units\":9.23366359435022,\"total\":1.10803963132203,\"price\":0.12,\"name\":\"first 10TB\"}],\"total\":1.10803963132203},\"requests\":{\"tiers\":[{\"units\":0,\"total\":0,\"name\":\"per 10,000 HTTPS requests\",\"price\":0.01},{\"total\":12.94268325,\"units\":1725.6911,\"name\":\"per 10,000 HTTP requests\",\"price\":0.0075}],\"total\":12.94268325}}},\"start_time\":\"2020-05-01T00:00:00.000Z\",\"status\":{\"status\":\"Outstanding\"},\"total\":{\"bandwidth\":0.00027189962565898895,\"bandwidth_cost\":3.2627955079078674e-05,\"bandwidth_units\":\"GB\",\"cost\":0,\"cost_before_discount\":8.302795507907867e-05,\"discount\":100,\"extras\":[{\"name\":\"Shared TLS Certificate\",\"recurring\":100,\"setup\":0}],\"extras_cost\":0,\"incurred_cost\":8.302795507907867e-05,\"plan_code\":\"developer\",\"plan_minimum\":0,\"plan_name\":\"developer\",\"requests\":66,\"requests_cost\":5.039999999999999e-05,\"terms\":\"Net15\"}}","originalRequest":{"name":"Get an invoice","description":"Get the invoice for the given invoice_id.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/billing/v2/account_customers/x4xCwxxJxGCx123Rx5xTx/invoices/7SlAESxcJ2zxHOV4gQ9y9X","path":["billing","v2","account_customers","x4xCwxxJxGCx123Rx5xTx","invoices","7SlAESxcJ2zxHOV4gQ9y9X"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get month-to-date billing estimate","request":{"name":"Get month-to-date billing estimate","description":"Get the current month-to-date estimate. This endpoint has two different responses. Under normal circumstances, it generally takes less than 5 seconds to generate but in certain cases can take up to 60 seconds. Once generated the month-to-date estimate is cached for 4 hours, and is available the next request will return the JSON representation of the month-to-date estimate. While a report is being generated in the background, this endpoint will return a 202 Accepted response. The full format of which can be found in detail in our billing calculation guide. There are certain accounts for which we are unable to generate a month-to-date estimate. For example, accounts who have parent-pay are unable to generate an MTD estimate. The parent accounts are able to generate a month-to-date estimate but that estimate will not include the child accounts amounts at this time.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/billing/v2/account_customers/{{customer_id}}/mtd_invoice","path":["billing","v2","account_customers","{{customer_id}}","mtd_invoice"],"host":["{{fastly_url}}"],"query":[{"key":"month","description":"2-digit month."},{"key":"year","description":"4-digit year."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"end_time\":\"2020-05-21T21:32:51.000Z\",\"start_time\":\"2020-05-01T00:00:00.000Z\",\"invoice_id\":\"MTD_4EkCABievWZowCL4E8JlTv\",\"regions\":{\"usa\":{\"cost\":10.04,\"bandwidth\":{\"total\":7.45,\"tiers\":[{\"name\":\"North America Bandwidth (62.055127895 gigabytes @ $.12)\",\"units\":62.055127895,\"price\":0.12,\"discounted_price\":0.12,\"total\":7.45}]},\"requests\":{\"total\":2.59,\"tiers\":[{\"name\":\"North America Requests (344.7019 units @ $.0075)\",\"units\":344.7019,\"price\":0.0075,\"discounted_price\":0.0075,\"total\":2.59}]}},\"south_africa\":{\"cost\":0.9,\"bandwidth\":{\"total\":0.78,\"tiers\":[{\"name\":\"South Africa Bandwidth (2.787144368 gigabytes @ $.28)\",\"units\":2.787144368,\"price\":0.28,\"discounted_price\":0.28,\"total\":0.78}]},\"requests\":{\"total\":0.12,\"tiers\":[{\"name\":\"South Africa Requests (7.8014 units @ $.016)\",\"units\":7.8014,\"price\":0.016,\"discounted_price\":0.016,\"total\":0.12}]}}},\"status\":{\"status\":\"MTD\"},\"total\":{\"cost\":54.019999999999996,\"balance_forward\":0,\"cached_at\":\"2020-02-21 20:26:18 UTC\",\"requests\":1763.3852000000004,\"requests_cost\":15.609999999999998,\"bandwidth\":266.252585978,\"bandwidth_cost\":38.41,\"percentile\":0,\"percentile_cost\":0,\"commit_shortfall\":0,\"discount\":0,\"discount_amount\":0,\"incurred_cost\":54.019999999999996,\"overage\":0,\"cost_before_discount\":54.019999999999996,\"extras\":[],\"extras_cost\":0,\"bandwidth_units\":null},\"lines\":[{\"line\":{\"plan_no\":286,\"description\":\"North America Bandwidth (62.055127895 gigabytes @ $.12)\",\"units\":62.055127895,\"per_unit_cost\":0.12,\"service_no\":11000335,\"service_type\":\"Bandwidth\",\"amount\":7.45,\"client_service_id\":\"North_America_Bandwidth\",\"client_plan_id\":\"CDN\"}},{\"line\":{\"plan_no\":286,\"description\":\"Europe Bandwidth (125.465421816 gigabytes @ $.12)\",\"units\":125.465421816,\"per_unit_cost\":0.12,\"service_no\":11000336,\"service_type\":\"Bandwidth\",\"amount\":15.06,\"client_service_id\":\"Europe_Bandwidth\",\"client_plan_id\":\"CDN\"}},{\"line\":{\"plan_no\":286,\"description\":\"Australia Bandwidth (3.305279657 gigabytes @ $.19)\",\"units\":3.305279657,\"per_unit_cost\":0.19,\"service_no\":11000337,\"service_type\":\"Bandwidth\",\"amount\":0.63,\"client_service_id\":\"Australia_Bandwidth\",\"client_plan_id\":\"CDN\"}},{\"line\":{\"plan_no\":286,\"description\":\"Asia Bandwidth (65.085918133 gigabytes @ $.19)\",\"units\":65.085918133,\"per_unit_cost\":0.19,\"service_no\":11000338,\"service_type\":\"Bandwidth\",\"amount\":12.37,\"client_service_id\":\"Asia_Bandwidth\",\"client_plan_id\":\"CDN\"}},{\"line\":{\"plan_no\":286,\"description\":\"Latin America Bandwidth (7.553694109 gigabytes @ $.28)\",\"units\":7.553694109,\"per_unit_cost\":0.28,\"service_no\":11000339,\"service_type\":\"Bandwidth\",\"amount\":2.12,\"client_service_id\":\"Latin_America_Bandwidth\",\"client_plan_id\":\"CDN\"}},{\"line\":{\"plan_no\":286,\"description\":\"North America Requests (344.7019 units @ $.0075)\",\"units\":344.7019,\"per_unit_cost\":0.0075,\"service_no\":11000347,\"service_type\":\"Requests\",\"amount\":2.59,\"client_service_id\":\"North_America_Requests\",\"client_plan_id\":\"CDN\"}},{\"line\":{\"plan_no\":286,\"description\":\"Europe Requests (900.2602 units @ $.009)\",\"units\":900.2602,\"per_unit_cost\":0.009,\"service_no\":11000348,\"service_type\":\"Requests\",\"amount\":8.1,\"client_service_id\":\"Europe_Requests\",\"client_plan_id\":\"CDN\"}},{\"line\":{\"plan_no\":286,\"description\":\"Australia Requests (22.902 units @ $.009)\",\"units\":22.902,\"per_unit_cost\":0.009,\"service_no\":11000349,\"service_type\":\"Requests\",\"amount\":0.21,\"client_service_id\":\"Australia_Requests\",\"client_plan_id\":\"CDN\"}},{\"line\":{\"plan_no\":286,\"description\":\"Asia Requests (459.5082 units @ $.009)\",\"units\":459.5082,\"per_unit_cost\":0.009,\"service_no\":11000350,\"service_type\":\"Requests\",\"amount\":4.14,\"client_service_id\":\"Asia_Requests\",\"client_plan_id\":\"CDN\"}},{\"line\":{\"plan_no\":286,\"description\":\"Latin America Requests (28.2115 units @ $.016)\",\"units\":28.2115,\"per_unit_cost\":0.016,\"service_no\":11000352,\"service_type\":\"Requests\",\"amount\":0.45,\"client_service_id\":\"Latin_America_Requests\",\"client_plan_id\":\"CDN\"}},{\"line\":{\"plan_no\":286,\"description\":\"South Africa Bandwidth (2.787144368 gigabytes @ $.28)\",\"units\":2.787144368,\"per_unit_cost\":0.28,\"service_no\":11000438,\"service_type\":\"Bandwidth\",\"amount\":0.78,\"client_service_id\":\"South_Africa_Bandwidth\",\"client_plan_id\":\"CDN\"}},{\"line\":{\"plan_no\":286,\"description\":\"South Africa Requests (7.8014 units @ $.016)\",\"units\":7.8014,\"per_unit_cost\":0.016,\"service_no\":11000440,\"service_type\":\"Requests\",\"amount\":0.12,\"client_service_id\":\"South_Africa_Requests\",\"client_plan_id\":\"CDN\"}}]}","originalRequest":{"name":"Get month-to-date billing estimate","description":"Get the current month-to-date estimate. This endpoint has two different responses. Under normal circumstances, it generally takes less than 5 seconds to generate but in certain cases can take up to 60 seconds. Once generated the month-to-date estimate is cached for 4 hours, and is available the next request will return the JSON representation of the month-to-date estimate. While a report is being generated in the background, this endpoint will return a 202 Accepted response. The full format of which can be found in detail in our billing calculation guide. There are certain accounts for which we are unable to generate a month-to-date estimate. For example, accounts who have parent-pay are unable to generate an MTD estimate. The parent accounts are able to generate a month-to-date estimate but that estimate will not include the child accounts amounts at this time.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Billing](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/billing/v2/account_customers/x4xCwxxJxGCx123Rx5xTx/mtd_invoice?month=05&year=2020","path":["billing","v2","account_customers","x4xCwxxJxGCx123Rx5xTx","mtd_invoice?month=05&year=2020"],"host":["https://api.fastly.com"],"query":[{"key":"month","description":"2-digit month."},{"key":"year","description":"4-digit year."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Customer Contact","description":"A Customer Contact is the base object that holds the different types of contact information Fastly uses to contact a customer.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| contact_type | string | The type of contact. |\n| customer_id | string | The alphanumeric string representing the customer for this customer contact. |\n| email | string | The email of this contact, when a user_id is not provided. |\n| name | string | The name of this contact, when user_id is not provided. |\n| phone | string | The phone number for this contact. Required for primary, technical, and security contact types. |\n| user_id | string | The alphanumeric string representing the user for this customer contact. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | An alphanumeric string identifying the customer contact. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"List contacts","request":{"name":"List contacts","description":"List all contacts from a specified customer ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/customer/{{customer_id}}/contacts","path":["customer","{{customer_id}}","contacts"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"id\":\"hTE5dRlSBICGPJxJwCH4M\",\"name\":null,\"email\":null,\"type\":\"security\",\"phone_number\":\"5555555559\",\"user_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"customer_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"created_at\":\"2020-06-14T14:43:01.000Z\",\"updated_at\":\"2020-06-14T14:43:01.000Z\",\"deleted_at\":null}]","originalRequest":{"name":"List contacts","description":"List all contacts from a specified customer ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/contacts","path":["customer","x4xCwxxJxGCx123Rx5xTx","contacts"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Add a new customer contact","request":{"name":"Add a new customer contact","description":"Create a contact.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"POST","url":{"raw":"{{fastly_url}}/customer/{{customer_id}}/contacts","path":["customer","{{customer_id}}","contacts"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"id\":\"hTE5dRlSBICGPJxJwCH4M\",\"name\":null,\"email\":null,\"type\":\"primary\",\"phone_number\":\"5555555559\",\"user_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"customer_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"created_at\":\"2020-06-14T14:43:01.000Z\",\"updated_at\":\"2020-06-14T14:43:01.000Z\",\"deleted_at\":null,\"phone\":\"5555555555\"}","originalRequest":{"name":"Add a new customer contact","description":"Create a contact.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"POST","url":{"raw":"https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/contacts","path":["customer","x4xCwxxJxGCx123Rx5xTx","contacts"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a contact","request":{"name":"Delete a contact","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/contact/#delete-contact)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"{{fastly_url}}/customer/{{customer_id}}/contact/{{contact_id}}","path":["customer","{{customer_id}}","contact","{{contact_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a contact","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/contact/#delete-contact)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/contact/x4xCwxxJxGCx123Rx5xTx","path":["customer","x4xCwxxJxGCx123Rx5xTx","contact","x4xCwxxJxGCx123Rx5xTx"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Customer","description":"A Customer is the base object that owns your Users and Services. Some information may be limited depending on access level.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| billing_contact_id | string | The alphanumeric string representing the primary billing contact. |\n| billing_network_type | string | Customer's current network revenue type. |\n| billing_ref | string | Used for adding purchased orders to customer's account. |\n| can_configure_wordpress | boolean | Whether this customer can view or edit wordpress. |\n| can_reset_passwords | boolean | Whether this customer can reset passwords. |\n| can_upload_vcl | boolean | Whether this customer can upload VCL. |\n| force_2fa | boolean | Specifies whether 2FA is forced or not forced on the customer account. Logs out non-2FA users once 2FA is force enabled. |\n| force_sso | boolean | Specifies whether SSO is forced or not forced on the customer account. |\n| has_account_panel | boolean | Specifies whether the account has access or does not have access to the account panel. |\n| has_improved_events | boolean | Specifies whether the account has access or does not have access to the improved events. |\n| has_improved_ssl_config | boolean | Whether this customer can view or edit the SSL config. |\n| has_openstack_logging | boolean | Specifies whether the account has enabled or not enabled openstack logging. |\n| has_pci | boolean | Specifies whether the account can edit PCI for a service. |\n| has_pci_passwords | boolean | Specifies whether PCI passwords are required for the account. |\n| ip_whitelist | string | The range of IP addresses authorized to access the customer account. |\n| legal_contact_id | string | The alphanumeric string identifying the account's legal contact. |\n| name | string | The name of the customer, generally the company name. |\n| owner_id | string | The alphanumeric string identifying the account owner. |\n| phone_number | string | The phone number associated with the account. |\n| postal_address | string | The postal address associated with the account. |\n| pricing_plan | string | The pricing plan this customer is under. |\n| pricing_plan_id | string | The alphanumeric string identifying the pricing plan. |\n| security_contact_id | string | The alphanumeric string identifying the account's security contact. |\n| technical_contact_id | string | The alphanumeric string identifying the account's technical contact. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying the customer. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"List users","request":{"name":"List users","description":"List all users from a specified customer id.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/customer/{{customer_id}}/users","path":["customer","{{customer_id}}","users"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"created_at\":\"2020-05-02T17:15:54.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"email_hash\":\"hTE5dRlSBICGPJxJwCH4M\",\"id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"locked\":false,\"login\":\"krisowner@example.com\",\"name\":\"Kris Owner\",\"require_new_password\":false,\"role\":\"user\",\"two_factor_auth_enabled\":true,\"two_factor_setup_required\":false,\"updated_at\":\"2020-05-21T18:45:00.000Z\"}]","originalRequest":{"name":"List users","description":"List all users from a specified customer id.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/users","path":["customer","x4xCwxxJxGCx123Rx5xTx","users"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get the logged in customer","request":{"name":"Get the logged in customer","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/customer/#get-logged-in-customer)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/current_customer","path":["current_customer"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"billing_contact_id\":null,\"billing_network_type\":\"public\",\"billing_ref\":null,\"can_configure_wordpress\":false,\"can_reset_passwords\":true,\"can_upload_vcl\":false,\"force_2fa\":false,\"force_sso\":false,\"has_account_panel\":true,\"has_improved_events\":false,\"has_improved_ssl_config\":false,\"has_openstack_logging\":false,\"has_pci\":false,\"has_pci_passwords\":false,\"id\":\"hTE5dRlSBICGPJxJwCH4M\",\"ip_whitelist\":\"0.0.0.0/0\",\"legal_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"name\":\"Test Account\",\"owner_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"phone_number\":\"5555555559\",\"postal_address\":null,\"pricing_plan\":\"developer\",\"pricing_plan_id\":\"6HW4welznAHVnMCJhY9QdX\",\"readonly\":false,\"requires_support_email\":false,\"security_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"technical_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"created_at\":\"2020-06-14T14:43:01.000Z\",\"updated_at\":\"2020-06-14T14:43:01.000Z\",\"deleted_at\":null}","originalRequest":{"name":"Get the logged in customer","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/customer/#get-logged-in-customer)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/current_customer","path":["current_customer"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get a customer","request":{"name":"Get a customer","description":"Get a specific customer.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/customer/{{customer_id}}","path":["customer","{{customer_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"billing_contact_id\":null,\"billing_network_type\":\"public\",\"billing_ref\":null,\"can_configure_wordpress\":false,\"can_reset_passwords\":true,\"can_upload_vcl\":false,\"force_2fa\":false,\"force_sso\":false,\"has_account_panel\":true,\"has_improved_events\":false,\"has_improved_ssl_config\":false,\"has_openstack_logging\":false,\"has_pci\":false,\"has_pci_passwords\":false,\"id\":\"hTE5dRlSBICGPJxJwCH4M\",\"ip_whitelist\":\"0.0.0.0/0\",\"legal_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"name\":\"Test Account\",\"owner_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"phone_number\":\"5555555559\",\"postal_address\":null,\"pricing_plan\":\"developer\",\"pricing_plan_id\":\"6HW4welznAHVnMCJhY9QdX\",\"readonly\":false,\"requires_support_email\":false,\"security_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"technical_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"created_at\":\"2020-06-14T14:43:01.000Z\",\"updated_at\":\"2020-06-14T14:43:01.000Z\",\"deleted_at\":null}","originalRequest":{"name":"Get a customer","description":"Get a specific customer.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx","path":["customer","x4xCwxxJxGCx123Rx5xTx"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a customer","request":{"name":"Update a customer","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/customer/#update-customer)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PUT","url":{"raw":"{{fastly_url}}/customer/{{customer_id}}","path":["customer","{{customer_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"billing_contact_id\":null,\"billing_network_type\":\"public\",\"billing_ref\":null,\"can_configure_wordpress\":false,\"can_reset_passwords\":true,\"can_upload_vcl\":false,\"force_2fa\":false,\"force_sso\":false,\"has_account_panel\":true,\"has_improved_events\":false,\"has_improved_ssl_config\":false,\"has_openstack_logging\":false,\"has_pci\":false,\"has_pci_passwords\":false,\"id\":\"hTE5dRlSBICGPJxJwCH4M\",\"ip_whitelist\":\"0.0.0.0/0\",\"legal_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"name\":\"Updated Test Account\",\"owner_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"phone_number\":\"5555555559\",\"postal_address\":null,\"pricing_plan\":\"developer\",\"pricing_plan_id\":\"6HW4welznAHVnMCJhY9QdX\",\"readonly\":false,\"requires_support_email\":false,\"security_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"technical_contact_id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"created_at\":\"2020-06-14T14:43:01.000Z\",\"updated_at\":\"2020-06-14T14:43:01.000Z\",\"deleted_at\":null}","originalRequest":{"name":"Update a customer","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/customer/#update-customer)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PUT","url":{"raw":"https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx","path":["customer","x4xCwxxJxGCx123Rx5xTx"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a customer","request":{"name":"Delete a customer","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/customer/#delete-customer)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"{{fastly_url}}/customer/{{customer_id}}","path":["customer","{{customer_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a customer","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/customer/#delete-customer)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx","path":["customer","x4xCwxxJxGCx123Rx5xTx"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Event logs","description":"Event logs are used to audit actions performed by customers.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| admin | boolean | Indicates if event was performed by Fastly. |\n| created_at | string | Date and time in ISO 8601 format. |\n| customer_id | string | Alphanumeric string identifying the customer. |\n| description | string | Description of the event. |\n| event_type | string | Type of event. Can be used with filter[event_type]. |\n|  | api_key.create | An API key was created. |\n|  | acl.create | An access control list was created. |\n|  | acl.delete | An access control list was deleted. |\n|  | acl.update | An access control list was updated. |\n|  | address.create | A customer billing address was created. |\n|  | address.delete | A customer billing address was deleted. |\n|  | address.update | A customer billing address was updated. |\n|  | backend.create | A backend was added to a service. |\n|  | backend.delete | A backend was removed from a service. |\n|  | backend.update | A backend was updated. |\n|  | billing.contact_update | A billing contact was updated. |\n|  | cache_settings.create | A cache settings configuration object was created. |\n|  | cache_settings.delete | A cache settings configuration object was deleted. |\n|  | cache_settings.update | A cache settings configuration object was updated. |\n|  | customer.create | A customer was created. |\n|  | customer.pricing | A customer pricing plan was changed. |\n|  | customer.update | A customer was updated. |\n|  | customer_feature.create | A feature flag was applied to the customer account. |\n|  | customer_feature.delete | A feature flag was removed from the customer account. |\n|  | director.create | A load-balancing director was created. |\n|  | director.delete | A load-balancing director was deleted. |\n|  | director.update | A load-balancing director was updated. |\n|  | director_backend.create | A backend was assigned to a load-balancing director. |\n|  | director_backend.delete | A backend was removed from a load-balancing director. |\n|  | domain.create | A domain was assigned to a service. |\n|  | domain.delete | A domain was removed from a service. |\n|  | domain.update | A domain was updated. |\n|  | gzip.create | A gzip policy was created. |\n|  | gzip.delete | A gzip policy was deleted. |\n|  | gzip.update | A gzip policy was updated. |\n|  | header.create | A header configuration object was created. |\n|  | header.delete | A header configuration object was deleted. |\n|  | header.update | A header configuration object was updated. |\n|  | healthcheck.create | A healthcheck was created. |\n|  | healthcheck.delete | A healthcheck was deleted. |\n|  | healthcheck.update | A healthcheck was updated. |\n|  | invitation.accept | An account invitation was accepted. |\n|  | invitation.sent | An account invitation was sent. |\n|  | invoice.failed_payment | An invoice payment failed. |\n|  | invoice.payment | An invoice was paid. |\n|  | io_settings.create | Image optimization was activated. |\n|  | io_settings.delete | Image optimization was deactivated. |\n|  | io_settings.update | Image optimization was updated. |\n|  | logging.create | A log endpoint was created. |\n|  | logging.delete | A log endpoint was deleted. |\n|  | logging.update | A log endpoint was updated. |\n|  | pool.create | A dynamic server pool was created. |\n|  | pool.delete | A dynamic server pool was deleted. |\n|  | pool.update | A dynamic server pool was updated. |\n|  | request_settings.create | A request settings configuration object was created. |\n|  | request_settings.delete | A request settings configuration object was deleted. |\n|  | request_settings.update | A request settings configuration object was updated. |\n|  | response_object.create | A response object was created. |\n|  | response_object.delete | A response object was deleted. |\n|  | response_object.update | A response object was updated. |\n|  | rule_status.update | A WAF rule status was updated. |\n|  | rule_status.upsert | A WAF rule status was upserted. |\n|  | server.create | A server was created as part of a dynamic server pool. |\n|  | server.delete | A server was deleted as part of a dynamic server pool. |\n|  | server.update | A server was updated as part of a dynamic server pool. |\n|  | service.create | A service was created. |\n|  | service.delete | A service was deleted. |\n|  | service.move | A service was moved to another customer. |\n|  | service.move_destination | A service was moved from another customer. |\n|  | service.move_source | A service was moved to another customer. |\n|  | service.purge_all | The cache was purged for a service. |\n|  | service.update | A service was updated. |\n|  | service_authorization.create | A service authorization was created. |\n|  | service_authorization.delete | A service authorization was deleted. |\n|  | service_authorization.update | A service authorization was updated. |\n|  | tls.bulk_certificate.create | A bulk TLS certificate was created. |\n|  | tls.bulk_certificate.delete | A bulk TLS certificate was deleted. |\n|  | tls.bulk_certificate.update | A bulk TLS certificate was updated. |\n|  | tls.certificate.create | A TLS certificate was created. |\n|  | tls.certificate.expiration_email | Certificate expiration email was sent. |\n|  | tls.certificate.update | A TLS certificate was updated. |\n|  | tls.certificate.delete | A TLS certificate was deleted. |\n|  | tls.configuration.update | TLS configuration was updated. |\n|  | tls.private_key.create | A private key was created. |\n|  | tls.private_key.delete | A private key was deleted. |\n|  | tls.activation.enable | TLS activation was enabled. |\n|  | tls.activation.update | TLS activation was updated. |\n|  | tls.activation.disable | TLS activation was disabled. |\n|  | tls.globalsign.domain.create | A GlobalSign SAN entry was added. |\n|  | tls.globalsign.domain.verify | GlobalSign SAN entry verification was requested. |\n|  | tls.globalsign.domain.delete | A GlobalSign SAN entry was deleted. |\n|  | tls.subscription.create | A TLS subscription was created. |\n|  | tls.subscription.delete | A TLS subscription was deleted. |\n|  | tls.subscription.dns_check_email | A TLS subscription renewal DNS check email was sent. |\n|  | token.create | An API token was created or a user logged into the web interface. |\n|  | token.destroy | An API token was revoked. |\n|  | two_factor_auth.disable | Two-factor authentication was disabled. |\n|  | two_factor_auth.enable | Two-factor authentication was enabled. |\n|  | user.create | A user account was created. |\n|  | user.destroy | A user account was deleted. |\n|  | user.lock | A user account was locked. |\n|  | user.login | Deprecated. See token.create. |\n|  | user.login_failure | A user account login attempt failed. |\n|  | user.logout | Deprecated. See token.destroy. |\n|  | user.password_update | An account password was updated. |\n|  | user.unlock | A user account was unlocked. |\n|  | user.update | A user account was updated. |\n|  | vcl.create | A custom VCL file was created. |\n|  | vcl.delete | A custom VCL file was deleted. |\n|  | vcl.update | A custom VCL file was updated. |\n|  | version.activate | A service version was activated. |\n|  | version.clone | A service version was cloned. |\n|  | version.copy | A service version was copied to another service. |\n|  | version.copy_destination | The service version was copied from another service. |\n|  | version.copy_source | The service version was copied to another service. |\n|  | version.create | A service version was created. |\n|  | version.deactivate | A service version was deactivated. |\n|  | version.lock | A service version was locked. |\n|  | version.update | A service version was updated. |\n|  | waf.configuration_set_update | A WAF configuration set was updated. |\n|  | waf.create | A WAF object was created. |\n|  | waf.delete | A WAF object was deleted. |\n|  | waf.update | A WAF object was updated. |\n|  | waf.enable | A WAF object was enabled. |\n|  | waf.disable | A WAF object was disabled. |\n|  | waf.owasp.create | A WAF OWASP setting was created. |\n|  | waf.owasp.update | A WAF OWASP setting was updated. |\n|  | waf.ruleset.deploy | A WAF ruleset was deployed. |\n|  | waf.ruleset.deploy_failure | A WAF ruleset's deployment failed. |\n|  | wordpress.create | A WordPress rule was created. |\n|  | wordpress.delete | A WordPress rule was deleted. |\n|  | wordpress.update | A WordPress rule was updated. |\n| id | string | Alphanumeric string identifying an event. |\n| ip | string | IP addresses that the event was requested from. |\n| metadata | object | Hash of key value pairs of additional information. |\n| service_id | string | Alphanumeric string identifying the service. |\n| token_id | string | Alphanumeric string identifying a token. |\n| type | string | Resource type. |\n| user_id | string | Alphanumeric string identifying the user. |","item":[{"name":"List events","request":{"name":"List events","description":"List all events for a particular customer. Events can be filtered by user, customer and event type. Events can be sorted by date.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/events","path":["events"],"host":["{{fastly_url}}"],"query":[{"key":"filter[customer_id]","description":"Limit the results returned to a specific customer."},{"key":"filter[event_type]","description":"Limit the returned events to a specific event_type."},{"key":"filter[service_id]","description":"Limit the results returned to a specific service."},{"key":"filter[token_id]","description":"Limit the returned events to a specific token."},{"key":"filter[user_id]","description":"Limit the results returned to a specific user."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."},{"key":"sort","description":"The order in which to list the results by creation date."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"attributes\":{\"admin\":false,\"created_at\":\"2016-06-06T20:05:10.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"description\":\"Version 2 was activated\",\"event_type\":\"version.activate\",\"ip\":\"127.0.0.0\",\"metadata\":{\"version_number\":2},\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"user_id\":\"4Pp0BW3UkBEJhG3N0kovLP\",\"token_id\":\"5Yo3XXnrQpjc20u0ybrf2g\"},\"id\":\"5IH1QmNSV1Qi7jXc4oIZlZ\",\"type\":\"event\"}],\"links\":{\"last\":\"http://api.fastly.com/events?filter[customer_id]=x4xCwxxJxGCx123Rx5xTx&page[number]=1&page[size]=1\"}}","originalRequest":{"name":"List events","description":"List all events for a particular customer. Events can be filtered by user, customer and event type. Events can be sorted by date.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/events?filter%5Bcustomer_id%5D=x4xCwxxJxGCx123Rx5xTx&page%5Bnumber%5D=1&page%5Bsize%5D=20&sort=created_at","path":["events?filter%5Bcustomer_id%5D=x4xCwxxJxGCx123Rx5xTx&page%5Bnumber%5D=1&page%5Bsize%5D=20&sort=created_at"],"host":["https://api.fastly.com"],"query":[{"key":"filter[customer_id]","description":"Limit the results returned to a specific customer."},{"key":"filter[event_type]","description":"Limit the returned events to a specific event_type."},{"key":"filter[service_id]","description":"Limit the results returned to a specific service."},{"key":"filter[token_id]","description":"Limit the returned events to a specific token."},{"key":"filter[user_id]","description":"Limit the results returned to a specific user."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."},{"key":"sort","description":"The order in which to list the results by creation date."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get an event","request":{"name":"Get an event","description":"Get a specific event.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/events/{{event_id}}","path":["events","{{event_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"attributes\":{\"admin\":false,\"created_at\":\"2020-06-01T21:29:38.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"description\":\"Version 2 was activated\",\"event_type\":\"version.activate\",\"ip\":\"127.0.0.0\",\"metadata\":{\"version_number\":2},\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"user_id\":\"6MwX4ZZM7Ji4Q3O07dI8Ln\",\"token_id\":\"5Yo3XXnrQpjc20u0ybrf2g\"},\"id\":\"1PTzLK8g1NRKMGu5kUb8SC\",\"type\":\"event\"}}","originalRequest":{"name":"Get an event","description":"Get a specific event.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/events/1PTzLK8g1NRKMGu5kUb8SC","path":["events","1PTzLK8g1NRKMGu5kUb8SC"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Invitations","description":"Invitations allow superusers and engineers to invite users to set up accounts as collaborators under a main customer account. Superusers can invite collaborators and assign them any role or permission level on a per-service basis. Engineers with no per-service limitations on their role can only invite new collaborators but cannot modify their permissions.\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| email | string | The email address of the invitee. |\n| limit_services | boolean | Indicates the user has limited access to the customer's services. |\n| role | string | The permissions role assigned to the user. Can be user, billing, engineer, or superuser. |\n| status_code | integer | Indicates whether or not the invitation is active. |\n|  | 0 | Inactive. |\n|  | 1 | Active. |\n| type | string | Resource type. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying an invitation. |\n| relationships.customer.id | string | Alphanumeric string identifying the customer. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"List invitations","request":{"name":"List invitations","description":"List all invitations.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/invitations","path":["invitations"],"host":["{{fastly_url}}"],"query":[{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"invitation\",\"attributes\":{\"created_at\":\"2020-03-15T20:10:09.000Z\",\"deleted_at\":null,\"email\":\"john@example.com\",\"role\":\"superuser\",\"status_code\":1,\"updated_at\":\"2020-03-15T20:10:09.000Z\"},\"relationships\":{\"customer\":{\"data\":[{\"type\":\"customer\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}]}}}],\"links\":{\"last\":\"http://api.fastly.com/invitations?page[number]=1&page[size]=100\"},\"meta\":{\"current_page\":1,\"per_page\":100,\"record_count\":1,\"total_pages\":1}}","originalRequest":{"name":"List invitations","description":"List all invitations.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/invitations?page%5Bnumber%5D=1&page%5Bsize%5D=20","path":["invitations?page%5Bnumber%5D=1&page%5Bsize%5D=20"],"host":["https://api.fastly.com"],"query":[{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create an invitation","request":{"name":"Create an invitation","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/invitations/#create-invitation)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/invitations","path":["invitations"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"invitation\",\"attributes\":{\"email\":\"thelma@example.com\",\"limit_services\":true,\"role\":\"engineer\"},\"relationships\":{\"customer\":{\"data\":[{\"id\":\"44tb1D3asjhhuh2SH8e8YD\",\"type\":\"customer\"}]},\"service_invitations\":{\"data\":[{\"type\":\"service_invitation\",\"attributes\":{\"permission\":\"purge_all\"},\"relationships\":{\"service\":{\"data\":{\"type\":\"service\",\"id\":\"6yrrdleXQ9QDtum9rMB0nr\"}}}}]}}}}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"7kP8T3JrqSD2ZdijWGxOB1\",\"type\":\"invitation\",\"attributes\":{\"created_at\":\"2020-05-09T18:45:17.000Z\",\"email\":\"thelma@example.com\",\"deleted_at\":null,\"role\":\"user\",\"status_code\":1,\"updated_at\":\"2020-05-09T18:45:17.000Z\",\"limit_services\":true},\"relationships\":{\"customer\":{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"customer\"}]},\"service_invitations\":{\"data\":[{\"id\":\"QNcWQmR5UIpVVO6f1Y3Rl\",\"type\":\"service_invitation\"}]}}},\"included\":[{\"id\":\"QNcWQmR5UIpVVO6f1Y3Rl\",\"type\":\"service_invitation\",\"attributes\":{\"permission\":\"purge_all\",\"created_at\":\"2020-05-09T18:45:18.000Z\",\"deleted_at\":null,\"updated_at\":\"2020-05-09T18:45:18.000Z\"}},{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"customer\",\"attributes\":{\"created_at\":\"2020-05-09T18:45:17.000Z\",\"deleted_at\":null,\"name\":\"Test\",\"phone_number\":\"875.788.2000 x29959\",\"postal_address\":null,\"updated_at\":\"2020-05-09T18:45:17.000Z\"}}]}","originalRequest":{"name":"Create an invitation","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/invitations/#create-invitation)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/invitations","path":["invitations"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"invitation\",\"attributes\":{\"email\":\"thelma@example.com\",\"limit_services\":true,\"role\":\"engineer\"},\"relationships\":{\"customer\":{\"data\":[{\"id\":\"44tb1D3asjhhuh2SH8e8YD\",\"type\":\"customer\"}]},\"service_invitations\":{\"data\":[{\"type\":\"service_invitation\",\"attributes\":{\"permission\":\"purge_all\"},\"relationships\":{\"service\":{\"data\":{\"type\":\"service\",\"id\":\"6yrrdleXQ9QDtum9rMB0nr\"}}}}]}}}}"}}}]},{"name":"Delete an invitation","request":{"name":"Delete an invitation","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/invitations/#delete-invitation)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/invitations/{{invitation_id}}","path":["invitations","{{invitation_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"204 No Content","name":"204 No Content","code":204,"header":[],"originalRequest":{"name":"Delete an invitation","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/invitations/#delete-invitation)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/invitations/3krg2uUGZzb2W9Euo4moOY","path":["invitations","3krg2uUGZzb2W9Euo4moOY"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}]},{"name":"Service authorizations","description":"A service authorization allows limited users to access only specified services.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| permission | string | The permission the user has in relation to the service. |\n| relationships.service.id | string | Alphanumeric string identifying the service. |\n| relationships.user.id | string | Alphanumeric string identifying the user. |\n| type | string | Resource type. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying a service authorization. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"Show service authorization","request":{"name":"Show service authorization","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#show-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/service-authorizations/{{service_authorization_id}}","path":["service-authorizations","{{service_authorization_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"created_at\":\"2020-03-15T20:10:09.000Z\",\"updated_at\":\"2020-03-15T20:10:09.000Z\",\"deleted_at\":null,\"permission\":\"read_only\"},\"relationships\":{\"service\":{\"data\":{\"type\":\"service\",\"id\":\"x4xCwxxJxGCx123Rx5xTx\"}},\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}}}}}","originalRequest":{"name":"Show service authorization","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#show-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/service-authorizations/3krg2uUGZzb2W9Euo4moOY","path":["service-authorizations","3krg2uUGZzb2W9Euo4moOY"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Delete service authorization","request":{"name":"Delete service authorization","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#delete-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service-authorizations/{{service_authorization_id}}","path":["service-authorizations","{{service_authorization_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"204 No Content","name":"204 No Content","code":204,"header":[],"originalRequest":{"name":"Delete service authorization","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#delete-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service-authorizations/3krg2uUGZzb2W9Euo4moOY","path":["service-authorizations","3krg2uUGZzb2W9Euo4moOY"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update service authorization","request":{"name":"Update service authorization","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#update-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PATCH","url":{"raw":"{{fastly_url}}/service-authorizations/{{service_authorization_id}}","path":["service-authorizations","{{service_authorization_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"permission\":\"read_only\"}}}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"created_at\":\"2020-03-15T20:07:34.000Z\",\"updated_at\":\"2020-03-15T20:07:34.000Z\",\"deleted_at\":null,\"permission\":\"read_only\"}}}","originalRequest":{"name":"Update service authorization","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#update-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PATCH","url":{"raw":"https://api.fastly.com/service-authorizations/3krg2uUGZzb2W9Euo4moOY","path":["service-authorizations","3krg2uUGZzb2W9Euo4moOY"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"permission\":\"read_only\"}}}"}}}]},{"name":"List service authorizations","request":{"name":"List service authorizations","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#list-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/service-authorizations","path":["service-authorizations"],"host":["{{fastly_url}}"],"query":[{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"created_at\":\"2020-03-15T20:10:09.000Z\",\"updated_at\":\"2020-03-15T20:10:09.000Z\",\"deleted_at\":null,\"permission\":\"read_only\"},\"relationships\":{\"service\":{\"data\":{\"type\":\"service\",\"id\":\"x4xCwxxJxGCx123Rx5xTx\"}},\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}}}}],\"links\":{\"last\":\"http://api.fastly.com/service-authorizations?page[number]=1&page[size]=100\"},\"meta\":{\"current_page\":1,\"per_page\":100,\"record_count\":1,\"total_pages\":1}}","originalRequest":{"name":"List service authorizations","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#list-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/service-authorizations?page%5Bnumber%5D=1&page%5Bsize%5D=20","path":["service-authorizations?page%5Bnumber%5D=1&page%5Bsize%5D=20"],"host":["https://api.fastly.com"],"query":[{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create service authorization","request":{"name":"Create service authorization","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#create-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"POST","url":{"raw":"{{fastly_url}}/service-authorizations","path":["service-authorizations"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"service_authorization\",\"attributes\":{\"permission\":\"read_only\"},\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}}}}}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"type\":\"service_authorization\",\"attributes\":{\"created_at\":\"2020-03-15T20:07:34.000Z\",\"updated_at\":\"2020-03-15T20:07:34.000Z\",\"deleted_at\":null,\"permission\":\"read_only\"},\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}}}}}","originalRequest":{"name":"Create service authorization","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#create-service-authorization)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"POST","url":{"raw":"https://api.fastly.com/service-authorizations","path":["service-authorizations"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"service_authorization\",\"attributes\":{\"permission\":\"read_only\"},\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}}}}}"}}}]},{"name":"Delete service authorizations","request":{"name":"Delete service authorizations","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#delete-service-authorization2)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service-authorizations","path":["service-authorizations"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json; ext=bulk"},{"key":"Accept","value":"application/vnd.api+json; ext=bulk"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\"},{\"id\":\"71ZA6hv2FO6tGEQIE203Xj\",\"type\":\"service_authorization\"}]}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"created_at\":\"2020-03-15T20:07:34.000Z\",\"updated_at\":\"2020-03-15T20:07:34.000Z\",\"deleted_at\":\"2020-03-16T20:07:34.000Z\"},\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}}}},{\"id\":\"71ZA6hv2FO6tGEQIE203Xj\",\"type\":\"service_authorization\",\"attributes\":{\"created_at\":\"2020-03-15T20:07:34.000Z\",\"updated_at\":\"2020-03-15T20:07:34.000Z\",\"deleted_at\":\"2020-03-16T20:07:34.000Z\"},\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"hTE5dRlSBICGPJxJwCH4M\"}}}}]}","originalRequest":{"name":"Delete service authorizations","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#delete-service-authorization2)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service-authorizations","path":["service-authorizations"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json; ext=bulk"},{"key":"Accept","value":"application/vnd.api+json; ext=bulk"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\"},{\"id\":\"71ZA6hv2FO6tGEQIE203Xj\",\"type\":\"service_authorization\"}]}"}}}]},{"name":"Update service authorizations","request":{"name":"Update service authorizations","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#update-service-authorization2)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PATCH","url":{"raw":"{{fastly_url}}/service-authorizations","path":["service-authorizations"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json; ext=bulk"},{"key":"Accept","value":"application/vnd.api+json; ext=bulk"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"permission\":\"read_only\"}},{\"id\":\"71ZA6hv2FO6tGEQIE203Xj\",\"type\":\"service_authorization\",\"attributes\":{\"permission\":\"purge_all\"}}]}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"created_at\":\"2020-03-15T20:07:34.000Z\",\"updated_at\":\"2020-03-15T20:07:34.000Z\",\"deleted_at\":null,\"permission\":\"read_only\"},\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}}}},{\"id\":\"71ZA6hv2FO6tGEQIE203Xj\",\"type\":\"service_authorization\",\"attributes\":{\"created_at\":\"2020-03-15T20:07:34.000Z\",\"updated_at\":\"2020-03-15T20:07:34.000Z\",\"deleted_at\":null,\"permission\":\"purge_all\"},\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"hTE5dRlSBICGPJxJwCH4M\"}}}}]}","originalRequest":{"name":"Update service authorizations","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/service-authorization/#update-service-authorization2)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PATCH","url":{"raw":"https://api.fastly.com/service-authorizations","path":["service-authorizations"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json; ext=bulk"},{"key":"Accept","value":"application/vnd.api+json; ext=bulk"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"service_authorization\",\"attributes\":{\"permission\":\"read_only\"}},{\"id\":\"71ZA6hv2FO6tGEQIE203Xj\",\"type\":\"service_authorization\",\"attributes\":{\"permission\":\"purge_all\"}}]}"}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Star","description":"A star allows users to mark services of interest.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| relationships.service.id | string | Alphanumeric string identifying the service. |\n| relationships.user.id | string | Alphanumeric string identifying the user. |\n| type | string | Resource type. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying a star. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"Get a star","request":{"name":"Get a star","description":"Show star.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/stars/{{star_id}}","path":["stars","{{star_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"star\",\"attributes\":{\"created_at\":\"2020-03-15T20:10:09.000Z\",\"updated_at\":\"2020-03-15T20:10:09.000Z\",\"deleted_at\":null},\"relationships\":{\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}},\"user\":{\"data\":{\"type\":\"user\",\"id\":\"x9KzsrACXZv8tPwlEDsKb6\"}}}}}","originalRequest":{"name":"Get a star","description":"Show star.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/stars/3krg2uUGZzb2W9Euo4moOY","path":["stars","3krg2uUGZzb2W9Euo4moOY"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Delete a star","request":{"name":"Delete a star","description":"Delete star.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"{{fastly_url}}/stars/{{star_id}}","path":["stars","{{star_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"204 No Content","name":"204 No Content","code":204,"header":[],"originalRequest":{"name":"Delete a star","description":"Delete star.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"https://api.fastly.com/stars/3krg2uUGZzb2W9Euo4moOY","path":["stars","3krg2uUGZzb2W9Euo4moOY"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"List stars","request":{"name":"List stars","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/star/#list-service-stars)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/stars","path":["stars"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"type\":\"star\",\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":[{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}]}}}],\"meta\":{\"current_page\":1,\"per_page\":100,\"record_count\":1,\"total_pages\":1},\"links\":{\"last\":\"http://api.fastly.com/stars?page[number]=1&page[size]=100\"}}","originalRequest":{"name":"List stars","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/star/#list-service-stars)**\n\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/stars","path":["stars"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a star","request":{"name":"Create a star","description":"Create star.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"POST","url":{"raw":"{{fastly_url}}/stars","path":["stars"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"star\",\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}}}}}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"star\",\"attributes\":{\"created_at\":\"2020-03-15T20:10:09.000Z\",\"updated_at\":\"2020-03-15T20:10:09.000Z\",\"deleted_at\":null},\"relationships\":{\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}},\"user\":{\"data\":{\"type\":\"user\",\"id\":\"x9KzsrACXZv8tPwlEDsKb6\"}}}}}","originalRequest":{"name":"Create a star","description":"Create star.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"POST","url":{"raw":"https://api.fastly.com/stars","path":["stars"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"star\",\"relationships\":{\"user\":{\"data\":{\"type\":\"user\",\"id\":\"6c7kAlo4vACNchGOdQxP37\"}},\"service\":{\"data\":{\"type\":\"service\",\"id\":\"SU1Z0isxPaozGVKXdv0eY\"}}}}}"}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"User","description":"A user of the Fastly API and web interface. A user is always associated with a customer. Some information may be limited depending on access level.\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| new_password | string | The user's new password. |\n| old_password | string | The user's current password. |\n| limit_services | boolean | Indicates that the user has limited access to the customer's services. |\n| locked | boolean | Indicates whether the is account is locked for editing or not. |\n| login | string | The login associated with the user (typically, an email address). |\n| name | string | The real life name of the user. |\n| require_new_password | boolean | Indicates if a new password is required at next login. |\n| role | string | The permissions role assigned to the user. Can be user, billing, engineer, or superuser. |\n| two_factor_auth_enabled | boolean | Indicates if 2FA is enabled on the user. |\n| two_factor_setup_required | boolean | Indicates if 2FA is required by the user's customer account. |\n| created_at | string | Date and time in ISO 8601 format. |\n| customer_id | string | Alphanumeric string identifying the customer. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| email_hash | string | The alphanumeric string identifying a email login. |\n| id | string | Alphanumeric string identifying the user. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"Get the current user","request":{"name":"Get the current user","description":"Get the logged in user.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/current_user","path":["current_user"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-05-02T17:15:54.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"email_hash\":\"hTE5dRlSBICGPJxJwCH4M\",\"id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"locked\":false,\"login\":\"krisowner@example.com\",\"name\":\"Kris Owner\",\"require_new_password\":false,\"role\":\"user\",\"two_factor_auth_enabled\":true,\"two_factor_setup_required\":false,\"updated_at\":\"2020-05-21T18:45:00.000Z\"}","originalRequest":{"name":"Get the current user","description":"Get the logged in user.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/current_user","path":["current_user"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get a user","request":{"name":"Get a user","description":"Get a specific user.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/user/{{user_id}}","path":["user","{{user_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-05-02T17:15:54.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"email_hash\":\"hTE5dRlSBICGPJxJwCH4M\",\"id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"locked\":false,\"login\":\"krisowner@example.com\",\"name\":\"Kris Owner\",\"require_new_password\":false,\"role\":\"user\",\"two_factor_auth_enabled\":true,\"two_factor_setup_required\":false,\"updated_at\":\"2020-05-21T18:45:00.000Z\"}","originalRequest":{"name":"Get a user","description":"Get a specific user.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/user/x9KzsrACXZv8tPwlEDsKb6","path":["user","x9KzsrACXZv8tPwlEDsKb6"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a user","request":{"name":"Update a user","description":"Update a user. Only users with the role of superuser can make changes to other users on the account. Non-superusers may use this endpoint to make changes to their own account. Modifications to login email require a valid password in the request body. Two-factor attributes are not editable via this endpoint.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PUT","url":{"raw":"{{fastly_url}}/user/{{user_id}}","path":["user","{{user_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-05-02T17:15:54.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"email_hash\":\"hTE5dRlSBICGPJxJwCH4M\",\"id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"locked\":false,\"login\":\"krisowner@example.com\",\"name\":\"Updated Name\",\"require_new_password\":false,\"role\":\"user\",\"two_factor_auth_enabled\":true,\"two_factor_setup_required\":false,\"updated_at\":\"2020-05-21T18:45:00.000Z\"}","originalRequest":{"name":"Update a user","description":"Update a user. Only users with the role of superuser can make changes to other users on the account. Non-superusers may use this endpoint to make changes to their own account. Modifications to login email require a valid password in the request body. Two-factor attributes are not editable via this endpoint.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PUT","url":{"raw":"https://api.fastly.com/user/x9KzsrACXZv8tPwlEDsKb6","path":["user","x9KzsrACXZv8tPwlEDsKb6"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a user","request":{"name":"Delete a user","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/user/#delete-user)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/user/{{user_id}}","path":["user","{{user_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a user","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/user/#delete-user)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/user/x9KzsrACXZv8tPwlEDsKb6","path":["user","x9KzsrACXZv8tPwlEDsKb6"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a user","request":{"name":"Create a user","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/user/#create-user)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/user","path":["user"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-05-02T17:15:54.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"email_hash\":\"hTE5dRlSBICGPJxJwCH4M\",\"id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"locked\":false,\"login\":\"krisowner@example.com\",\"name\":\"Kris Owner\",\"require_new_password\":false,\"role\":\"user\",\"two_factor_auth_enabled\":true,\"two_factor_setup_required\":false,\"updated_at\":\"2020-05-21T18:45:00.000Z\"}","originalRequest":{"name":"Create a user","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/account/user/#create-user)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/user","path":["user"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Update the user's password","request":{"name":"Update the user's password","description":"Update the user's password to a new one.\n> **Authorization**: Username and password.\n","method":"POST","url":{"raw":"{{fastly_url}}/current_user/password","path":["current_user","password"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-05-02T17:15:54.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"email_hash\":\"hTE5dRlSBICGPJxJwCH4M\",\"id\":\"x9KzsrACXZv8tPwlEDsKb6\",\"locked\":false,\"login\":\"krisowner@example.com\",\"name\":\"Kris Owner\",\"require_new_password\":false,\"role\":\"user\",\"two_factor_auth_enabled\":true,\"two_factor_setup_required\":false,\"updated_at\":\"2020-05-21T18:45:00.000Z\"}","originalRequest":{"name":"Update the user's password","description":"Update the user's password to a new one.\n> **Authorization**: Username and password.\n","method":"POST","url":{"raw":"https://api.fastly.com/current_user/password","path":["current_user","password"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Request a password reset","request":{"name":"Request a password reset","description":"Requests a password reset for the specified user.","method":"POST","url":{"raw":"{{fastly_url}}/user/{{user_login}}/password/request_reset","path":["user","{{user_login}}","password","request_reset"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}]},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Request a password reset","description":"Requests a password reset for the specified user.","method":"POST","url":{"raw":"https://api.fastly.com/user/krisowner@example.com/password/request_reset","path":["user","krisowner@example.com","password","request_reset"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}]}}]}]}]},{"name":"Access control lists","item":[{"name":"ACL Entry","description":"An ACL entry holds an individual IP address or subnet range and is a member of an ACL. ACL entries are versionless, which means they can be created, modified, or deleted without activating a new version of your service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| comment | string | A freeform descriptive note. |\n| ip | string | An IP address. |\n| negated | integer | Whether to negate the match. Useful primarily when creating individual exceptions to larger subnets. |\n| subnet | integer | Number of bits for the subnet mask applied to the IP address.  For IPv4 addresses, a value of 32 represents the smallest subnet mask (1 address), 24 represents a class C subnet mask (256 addresses), 16 represents a class B subnet mask (65k addresses),  and 8 is class A subnet mask (16m addresses). If not provided, no mask is applied. |\n| acl_id | string | Alphanumeric string identifying a ACL. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying an ACL Entry. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"List ACL entries","request":{"name":"List ACL entries","description":"List ACL entries for a specified ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/acl/{{acl_id}}/entries","path":["service","{{service_id}}","acl","{{acl_id}}","entries"],"host":["{{fastly_url}}"],"query":[{"key":"direction","description":"Direction in which to sort results."},{"key":"page","description":"Current page."},{"key":"per_page","description":"Number of records per page."},{"key":"sort","description":"Field on which to sort."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"id\":\"6yxNzlOpW1V7JfSwvLGtOc\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"acl_id\":\"2cFflPOskFLhmnZJEfUake\",\"ip\":\"127.0.0.1\",\"negated\":0,\"subnet\":null,\"comment\":\"\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"updated_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null}]","originalRequest":{"name":"List ACL entries","description":"List ACL entries for a specified ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/acl/6tUXdegLTf5BCig0zGFrU3/entries?direction=ascend&page=1&per_page=20&sort=created","path":["service","SU1Z0isxPaozGVKXdv0eY","acl","6tUXdegLTf5BCig0zGFrU3","entries?direction=ascend&page=1&per_page=20&sort=created"],"host":["https://api.fastly.com"],"query":[{"key":"direction","description":"Direction in which to sort results."},{"key":"page","description":"Current page."},{"key":"per_page","description":"Number of records per page."},{"key":"sort","description":"Field on which to sort."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update multiple ACL entries","request":{"name":"Update multiple ACL entries","description":"Update multiple ACL entries on the same ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/service/{{service_id}}/acl/{{acl_id}}/entries","path":["service","{{service_id}}","acl","{{acl_id}}","entries"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"entries\":[{\"op\":\"create\",\"ip\":\"192.168.0.1\",\"subnet\":8},{\"op\":\"update\",\"id\":\"6yxNzlOpW1V7JfSwvLGtOc\",\"ip\":\"192.168.0.2\",\"subnet\":16},{\"op\":\"delete\",\"id\":\"6yxNzlOpW1V7JfSwvLGtOc\"}]}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Update multiple ACL entries","description":"Update multiple ACL entries on the same ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/acl/6tUXdegLTf5BCig0zGFrU3/entries","path":["service","SU1Z0isxPaozGVKXdv0eY","acl","6tUXdegLTf5BCig0zGFrU3","entries"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"entries\":[{\"op\":\"create\",\"ip\":\"192.168.0.1\",\"subnet\":8},{\"op\":\"update\",\"id\":\"6yxNzlOpW1V7JfSwvLGtOc\",\"ip\":\"192.168.0.2\",\"subnet\":16},{\"op\":\"delete\",\"id\":\"6yxNzlOpW1V7JfSwvLGtOc\"}]}"}}}]},{"name":"Describe an ACL entry","request":{"name":"Describe an ACL entry","description":"Retrieve a single ACL entry.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/acl/{{acl_id}}/entry/{{acl_entry_id}}","path":["service","{{service_id}}","acl","{{acl_id}}","entry","{{acl_entry_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"id\":\"6yxNzlOpW1V7JfSwvLGtOc\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"acl_id\":\"2cFflPOskFLhmnZJEfUake\",\"ip\":\"127.0.0.1\",\"negated\":0,\"subnet\":null,\"comment\":\"\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"updated_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null}","originalRequest":{"name":"Describe an ACL entry","description":"Retrieve a single ACL entry.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/acl/6tUXdegLTf5BCig0zGFrU3/entry/6yxNzlOpW1V7JfSwvLGtOc","path":["service","SU1Z0isxPaozGVKXdv0eY","acl","6tUXdegLTf5BCig0zGFrU3","entry","6yxNzlOpW1V7JfSwvLGtOc"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Delete an ACL entry","request":{"name":"Delete an ACL entry","description":"Delete an ACL entry from a specified ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/acl/{{acl_id}}/entry/{{acl_entry_id}}","path":["service","{{service_id}}","acl","{{acl_id}}","entry","{{acl_entry_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete an ACL entry","description":"Delete an ACL entry from a specified ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/acl/6tUXdegLTf5BCig0zGFrU3/entry/6yxNzlOpW1V7JfSwvLGtOc","path":["service","SU1Z0isxPaozGVKXdv0eY","acl","6tUXdegLTf5BCig0zGFrU3","entry","6yxNzlOpW1V7JfSwvLGtOc"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update an ACL entry","request":{"name":"Update an ACL entry","description":"Update an ACL entry for a specified ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/service/{{service_id}}/acl/{{acl_id}}/entry/{{acl_entry_id}}","path":["service","{{service_id}}","acl","{{acl_id}}","entry","{{acl_entry_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"subnet\":8}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"id\":\"6yxNzlOpW1V7JfSwvLGtOc\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"acl_id\":\"2cFflPOskFLhmnZJEfUake\",\"ip\":\"127.0.0.1\",\"negated\":0,\"subnet\":8,\"comment\":\"\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"updated_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null}","originalRequest":{"name":"Update an ACL entry","description":"Update an ACL entry for a specified ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/acl/6tUXdegLTf5BCig0zGFrU3/entry/6yxNzlOpW1V7JfSwvLGtOc","path":["service","SU1Z0isxPaozGVKXdv0eY","acl","6tUXdegLTf5BCig0zGFrU3","entry","6yxNzlOpW1V7JfSwvLGtOc"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"subnet\":8}"}}}]},{"name":"Create an ACL entry","request":{"name":"Create an ACL entry","description":"Add an ACL entry to an ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/acl/{{acl_id}}/entry","path":["service","{{service_id}}","acl","{{acl_id}}","entry"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"subnet\":0,\"ip\":\"127.0.0.1\"}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"id\":\"6yxNzlOpW1V7JfSwvLGtOc\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"acl_id\":\"2cFflPOskFLhmnZJEfUake\",\"ip\":\"127.0.0.1\",\"negated\":0,\"subnet\":null,\"comment\":\"\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"updated_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null}","originalRequest":{"name":"Create an ACL entry","description":"Add an ACL entry to an ACL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/acl/6tUXdegLTf5BCig0zGFrU3/entry","path":["service","SU1Z0isxPaozGVKXdv0eY","acl","6tUXdegLTf5BCig0zGFrU3","entry"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"subnet\":0,\"ip\":\"127.0.0.1\"}"}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"ACL","description":"An access control list or \"ACL\" specifies individual IP addresses or subnet ranges and can be accessed and used from Fastly VCL.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| name | string | Name for the ACL. Must start with an alphanumeric character and contain only alphanumeric characters, underscores, and whitespace. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying a ACL. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List ACLs","request":{"name":"List ACLs","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/acls/acl/#list-acls)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/acl","path":["service","{{service_id}}","version","{{version_id}}","acl"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"version\":1,\"name\":\"test-acl\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"id\":\"2cFflPOskFLhmnZJEKU7y6\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"updated_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null}]","originalRequest":{"name":"List ACLs","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/acls/acl/#list-acls)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/acl","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","acl"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a new ACL","request":{"name":"Create a new ACL","description":"Create a new ACL attached to the specified service version. A new, empty ACL must be attached to a draft version of a service. The version associated with the ACL must be activated to be used.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/acl","path":["service","{{service_id}}","version","{{version_id}}","acl"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"version\":1,\"name\":\"test-acl\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"id\":\"2cFflPOskFLhmnZJEKU7y6\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"updated_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null}","originalRequest":{"name":"Create a new ACL","description":"Create a new ACL attached to the specified service version. A new, empty ACL must be attached to a draft version of a service. The version associated with the ACL must be activated to be used.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/acl","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","acl"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Describe an ACL","request":{"name":"Describe an ACL","description":"Retrieve a single ACL by name for the version and service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/acl/{{acl_name}}","path":["service","{{service_id}}","version","{{version_id}}","acl","{{acl_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"version\":1,\"name\":\"test-acl\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"id\":\"2cFflPOskFLhmnZJEKU7y6\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"updated_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null}","originalRequest":{"name":"Describe an ACL","description":"Retrieve a single ACL by name for the version and service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/acl/test-acl","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","acl","test-acl"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update an ACL","request":{"name":"Update an ACL","description":"Update an ACL for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/acl/{{acl_name}}","path":["service","{{service_id}}","version","{{version_id}}","acl","{{acl_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"version\":1,\"name\":\"updated-test-acl\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"id\":\"2cFflPOskFLhmnZJEKU7y6\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"updated_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null}","originalRequest":{"name":"Update an ACL","description":"Update an ACL for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/acl/test-acl","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","acl","test-acl"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete an ACL","request":{"name":"Delete an ACL","description":"Delete an ACL from the specified service version. To remove an ACL from use, the ACL must be deleted from a draft version and the version without the ACL must be activated.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/acl/{{acl_name}}","path":["service","{{service_id}}","version","{{version_id}}","acl","{{acl_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete an ACL","description":"Delete an ACL from the specified service version. To remove an ACL from use, the ACL must be deleted from a draft version and the version without the ACL must be activated.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/acl/test-acl","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","acl","test-acl"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}]},{"name":"Authentication tokens","item":[{"name":"Automation Tokens","description":"Automation tokens differ from other token types because they are not tied to a specific person and therefore are not subject to the lifecycle of such accounts. Automation tokens are sometimes also called \"service accounts\". They are designed for API automation use-cases such as continuous integration, deployment pipelines, or automation scripts. For more information about authentication tokens, review the Authentication token documentation.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| expires_at | string | Time-stamp (UTC) of when the token will expire (optional). |\n| created_at | string | Time-stamp (UTC) of when the token was created. |\n| last_used_at | string | Time-stamp (UTC) of when the token was last used. |\n| user_agent | string | User-Agent header of the client that last used the token. |","item":[{"name":"List Automation Tokens for a customer","request":{"name":"List Automation Tokens for a customer","description":"Lists all automation tokens for a customer.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/automation-tokens","path":["automation-tokens"],"host":["{{fastly_url}}"],"query":[{"key":"page","description":""},{"key":"per_page","description":""}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"FASTLY_AUTOMATION_TOKEN_ID\",\"customer_id\":\"FASTLY_CUSTOMER_ID\",\"name\":\"automation-token\",\"role\":\"engineer\",\"ip\":null,\"user_agent\":null,\"scopes\":\"global\",\"services\":[],\"service_id\":null,\"sudo_expires_at\":null,\"last_used_at\":null,\"created_at\":\"2022-06-07T20:43:14Z\",\"expires_at\":\"2022-06-07T23:00:00Z\"}],\"meta\":{\"current_page\":1,\"per_page\":100,\"record_count\":1,\"total_pages\":1}}","originalRequest":{"name":"List Automation Tokens for a customer","description":"Lists all automation tokens for a customer.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/automation-tokens","path":["automation-tokens"],"host":["https://api.fastly.com"],"query":[{"key":"page","description":""},{"key":"per_page","description":""}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create Automation Token","request":{"name":"Create Automation Token","description":"Creates a new automation token.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"POST","url":{"raw":"{{fastly_url}}/automation-tokens","path":["automation-tokens"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"201 Created","name":"201 Created","code":201,"header":[],"body":"{\"data\":{\"id\":\"FASTLY_AUTOMATION_TOKEN_ID\",\"customer_id\":\"FASTLY_CUSTOMER_ID\",\"name\":\"automation-token01\",\"access_token\":\"\",\"role\":\"engineer\",\"ip\":null,\"user_agent\":null,\"scopes\":\"global\",\"scope\":\"\",\"services\":[],\"service_id\":null,\"sudo_expires_at\":null,\"last_used_at\":null,\"created_at\":\"2022-06-07T20:43:14Z\",\"expires_at\":\"2022-06-07T23:00:00Z\"}}","originalRequest":{"name":"Create Automation Token","description":"Creates a new automation token.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"POST","url":{"raw":"https://api.fastly.com/automation-tokens","path":["automation-tokens"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Retrieve an Automation Token by ID","request":{"name":"Retrieve an Automation Token by ID","description":"Retrieves an automation token by ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/automation-tokens/{{id}}","path":["automation-tokens","{{id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"FASTLY_AUTOMATION_TOKEN_ID\",\"customer_id\":\"FASTLY_CUSTOMER_ID\",\"name\":\"automation-token\",\"role\":\"engineer\",\"ip\":null,\"user_agent\":null,\"scopes\":\"global\",\"services\":[],\"service_id\":null,\"sudo_expires_at\":null,\"last_used_at\":null,\"created_at\":\"2022-06-07T20:43:14Z\",\"expires_at\":\"2022-06-07T23:00:00Z\"}}","originalRequest":{"name":"Retrieve an Automation Token by ID","description":"Retrieves an automation token by ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/automation-tokens/{{id}}","path":["automation-tokens","{{id}}"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Delete an Automation Token by ID","request":{"name":"Delete an Automation Token by ID","description":"Delete an automation token by ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"{{fastly_url}}/automation-tokens/{{id}}","path":["automation-tokens","{{id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{}","originalRequest":{"name":"Delete an Automation Token by ID","description":"Delete an automation token by ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"https://api.fastly.com/automation-tokens/{{id}}","path":["automation-tokens","{{id}}"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"List Automation Token Services","request":{"name":"List Automation Token Services","description":"List of services associated with the automation token.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/automation-tokens/{{id}}/services","path":["automation-tokens","{{id}}","services"],"host":["{{fastly_url}}"],"query":[{"key":"page","description":""},{"key":"per_page","description":""}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[\"SU1Z0isxPaozGVKXdv0eX\",\"SU1Z0isxPaozGVKXdv0eY\",\"SU1Z0isxPaozGVKXdv0eZ\"],\"meta\":{\"current_page\":1,\"per_page\":100,\"record_count\":3,\"total_pages\":1}}","originalRequest":{"name":"List Automation Token Services","description":"List of services associated with the automation token.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/automation-tokens/{{id}}/services","path":["automation-tokens","{{id}}","services"],"host":["https://api.fastly.com"],"query":[{"key":"page","description":""},{"key":"per_page","description":""}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"User tokens","description":"An API Token is used to identify who is making the API call. Users can create multiple tokens to suit their needs.\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| name | string | Name of the token. |\n| scope | string | Space-delimited list of authorization scope. |\n|  | global | This is the default scope covering all supported capabilities. |\n|  | purge_select | Allows purging with surrogate key and URL. Disallows purging with purge-all. |\n|  | purge_all | Allows purging an entire service via purge_all. |\n|  | global:read | Allows read-only access to account information, configuration, and stats. |\n| services | array | List of alphanumeric strings identifying services (optional). If no services are specified, the token will have access to all services on the account. |\n| access_token | string | The alphanumeric string for accessing the API (only available on token creation). |\n| created_at | string | Time-stamp (UTC) of when the token was created. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| expires_at | string | Time-stamp (UTC) of when the token will expire (optional). |\n| id | string | Alphanumeric string identifying a token. |\n| ip | string | IP Address of the client that last used the token. |\n| last_used_at | string | Time-stamp (UTC) of when the token was last used. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| user_agent | string | User-Agent header of the client that last used the token. |\n| user_id | string | Alphanumeric string identifying the user. |","item":[{"name":"List tokens for the authenticated user","request":{"name":"List tokens for the authenticated user","description":"List all tokens belonging to the authenticated user.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/tokens","path":["tokens"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"id\":\"5Yo3XXnrQpjc20u0ybrf2g\",\"user_id\":\"4y5K5trZocEAQYkesWlk7M\",\"services\":[],\"name\":\"test-token\",\"scope\":\"global\",\"created_at\":\"2020-06-22T03:19:48.000Z\",\"last_used_at\":\"2020-06-22T03:19:48.000Z\",\"expires_at\":\"2020-07-28T19:24:50.000Z\",\"ip\":\"127.17.202.173\",\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36\"}]","originalRequest":{"name":"List tokens for the authenticated user","description":"List all tokens belonging to the authenticated user.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/tokens","path":["tokens"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a token","request":{"name":"Create a token","description":"Create an API token. If two-factor authentication is enabled for your account, review the instructions for including a one-time password in the request.\n> **Authorization**: Username and password, Requires [API token](/reference/api/auth-tokens).\n","method":"POST","url":{"raw":"{{fastly_url}}/tokens","path":["tokens"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"id\":\"5Yo3XXnrQpjc20u0ybrf2g\",\"user_id\":\"4y5K5trZocEAQYkesWlk7M\",\"services\":[\"5VqE6MOOy1QFJbgmCK41pY\",\"6VqE6MOOy1QFJbgmCK41pZ\"],\"name\":\"test-token\",\"scope\":\"global\",\"created_at\":\"2020-06-22T03:19:48.000Z\",\"last_used_at\":\"2020-06-22T03:19:48.000Z\",\"expires_at\":\"2020-07-28T19:24:50.000Z\",\"ip\":\"127.17.202.173\",\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36\",\"access_token\":\"YOUR_FASTLY_TOKEN\"}","originalRequest":{"name":"Create a token","description":"Create an API token. If two-factor authentication is enabled for your account, review the instructions for including a one-time password in the request.\n> **Authorization**: Username and password, Requires [API token](/reference/api/auth-tokens).\n","method":"POST","url":{"raw":"https://api.fastly.com/tokens","path":["tokens"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Revoke multiple tokens","request":{"name":"Revoke multiple tokens","description":"Revoke Tokens in bulk format. Users may only revoke their own tokens. Superusers may revoke tokens of others.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"{{fastly_url}}/tokens","path":["tokens"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json; ext=bulk"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"token\"},{\"id\":\"71ZA6hv2FO6tGEQIE203Xj\",\"type\":\"token\"}]}"}},"response":[{"status":"204 No Content","name":"204 No Content","code":204,"header":[],"originalRequest":{"name":"Revoke multiple tokens","description":"Revoke Tokens in bulk format. Users may only revoke their own tokens. Superusers may revoke tokens of others.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"https://api.fastly.com/tokens","path":["tokens"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json; ext=bulk"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOY\",\"type\":\"token\"},{\"id\":\"71ZA6hv2FO6tGEQIE203Xj\",\"type\":\"token\"}]}"}}}]},{"name":"List tokens for a customer","request":{"name":"List tokens for a customer","description":"List all tokens belonging to a specific customer.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/customer/{{customer_id}}/tokens","path":["customer","{{customer_id}}","tokens"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"id\":\"5Yo3XXnrQpjc20u0ybrf2g\",\"user_id\":\"4y5K5trZocEAQYkesWlk7M\",\"services\":[],\"name\":\"test-token\",\"scope\":\"global\",\"created_at\":\"2020-06-22T03:19:48.000Z\",\"last_used_at\":\"2020-06-22T03:19:48.000Z\",\"expires_at\":\"2020-07-28T19:24:50.000Z\",\"ip\":\"127.17.202.173\",\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36\"}]","originalRequest":{"name":"List tokens for a customer","description":"List all tokens belonging to a specific customer.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/customer/x4xCwxxJxGCx123Rx5xTx/tokens","path":["customer","x4xCwxxJxGCx123Rx5xTx","tokens"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get the current token","request":{"name":"Get the current token","description":"Get a single token based on the access_token used in the request.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/tokens/self","path":["tokens","self"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"id\":\"5Yo3XXnrQpjc20u0ybrf2g\",\"user_id\":\"4y5K5trZocEAQYkesWlk7M\",\"services\":[],\"name\":\"test-token\",\"scope\":\"global\",\"created_at\":\"2020-06-22T03:19:48.000Z\",\"last_used_at\":\"2020-06-22T03:19:48.000Z\",\"expires_at\":\"2020-07-28T19:24:50.000Z\",\"ip\":\"127.17.202.173\",\"user_agent\":\"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_3) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/56.0.2924.87 Safari/537.36\"}","originalRequest":{"name":"Get the current token","description":"Get a single token based on the access_token used in the request.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/tokens/self","path":["tokens","self"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Revoke the current token","request":{"name":"Revoke the current token","description":"Revoke a token that is used to authenticate the request.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"{{fastly_url}}/tokens/self","path":["tokens","self"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"204 No Content","name":"204 No Content","code":204,"header":[],"originalRequest":{"name":"Revoke the current token","description":"Revoke a token that is used to authenticate the request.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"https://api.fastly.com/tokens/self","path":["tokens","self"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Revoke a token","request":{"name":"Revoke a token","description":"Revoke a specific token by its id.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"{{fastly_url}}/tokens/{{token_id}}","path":["tokens","{{token_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"204 No Content","name":"204 No Content","code":204,"header":[],"originalRequest":{"name":"Revoke a token","description":"Revoke a specific token by its id.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"DELETE","url":{"raw":"https://api.fastly.com/tokens/5Yo3XXnrQpjc20u0ybrf2g","path":["tokens","5Yo3XXnrQpjc20u0ybrf2g"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}]}]},{"name":"Edge dictionaries","item":[{"name":"Dictionary info","description":"Dictionary Info is a set of metadata describing properties of a dictionary which change as items are added and removed.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| digest | string | A hash of all the dictionary content. |\n| item_count | integer | The number of items currently in the dictionary. |\n| last_updated | string | Timestamp (UTC) when the dictionary was last updated or an item was added or removed. |","item":[{"name":"Get edge dictionary metadata","request":{"name":"Get edge dictionary metadata","description":"Retrieve metadata for a single dictionary by ID for a version and service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/dictionary/{{dictionary_id}}/info","path":["service","{{service_id}}","version","{{version_id}}","dictionary","{{dictionary_id}}","info"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"item_count\":1,\"last_updated\":\"2020-06-04 19:23:11\",\"digest\":\"43ee763040973ca602549c94c5357a41c280afbb54e48d436af88f4e40d73081\"}","originalRequest":{"name":"Get edge dictionary metadata","description":"Retrieve metadata for a single dictionary by ID for a version and service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/dictionary/3vjTN8v1O7nOAY7aNDGOL/info","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","dictionary","3vjTN8v1O7nOAY7aNDGOL","info"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Dictionary item","description":"A Dictionary Item is a single key-value pair that makes up an entry in a Dictionary. Dictionary Items can be added, removed and modified without activating a new version of the associated service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| item_key | string | Item key, maximum 256 characters. |\n| item_value | string | Item value, maximum 8000 characters. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| dictionary_id | string | Alphanumeric string identifying a Dictionary. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"List items in an edge dictionary","request":{"name":"List items in an edge dictionary","description":"List of DictionaryItems given service and dictionary ID.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/dictionary/{{dictionary_id}}/items","path":["service","{{service_id}}","dictionary","{{dictionary_id}}","items"],"host":["{{fastly_url}}"],"query":[{"key":"direction","description":"Direction in which to sort results."},{"key":"page","description":"Current page."},{"key":"per_page","description":"Number of records per page."},{"key":"sort","description":"Field on which to sort."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"dictionary_id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"item_key\":\"test-key\",\"item_value\":\"test-value\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null,\"updated_at\":\"2020-04-21T18:14:32.000Z\"}]","originalRequest":{"name":"List items in an edge dictionary","description":"List of DictionaryItems given service and dictionary ID.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/dictionary/3vjTN8v1O7nOAY7aNDGOL/items?direction=ascend&page=1&per_page=20&sort=created","path":["service","SU1Z0isxPaozGVKXdv0eY","dictionary","3vjTN8v1O7nOAY7aNDGOL","items?direction=ascend&page=1&per_page=20&sort=created"],"host":["https://api.fastly.com"],"query":[{"key":"direction","description":"Direction in which to sort results."},{"key":"page","description":"Current page."},{"key":"per_page","description":"Number of records per page."},{"key":"sort","description":"Field on which to sort."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update multiple entries in an edge dictionary","request":{"name":"Update multiple entries in an edge dictionary","description":"Update DictionaryItem in batch for given service, dictionary ID and key/value pairs for items.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/service/{{service_id}}/dictionary/{{dictionary_id}}/items","path":["service","{{service_id}}","dictionary","{{dictionary_id}}","items"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"items\":[{\"op\":\"create\",\"item_key\":\"test-key\",\"item_value\":\"new-value\"},{\"op\":\"update\",\"item_key\":\"test-key-2\",\"item_value\":\"new-value-2\"},{\"op\":\"upsert\",\"item_key\":\"test-key-3\",\"item_value\":\"new-value-3\"},{\"op\":\"delete\",\"item_key\":\"test-key-4\"}]}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Update multiple entries in an edge dictionary","description":"Update DictionaryItem in batch for given service, dictionary ID and key/value pairs for items.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/dictionary/3vjTN8v1O7nOAY7aNDGOL/items","path":["service","SU1Z0isxPaozGVKXdv0eY","dictionary","3vjTN8v1O7nOAY7aNDGOL","items"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"items\":[{\"op\":\"create\",\"item_key\":\"test-key\",\"item_value\":\"new-value\"},{\"op\":\"update\",\"item_key\":\"test-key-2\",\"item_value\":\"new-value-2\"},{\"op\":\"upsert\",\"item_key\":\"test-key-3\",\"item_value\":\"new-value-3\"},{\"op\":\"delete\",\"item_key\":\"test-key-4\"}]}"}}}]},{"name":"Get an item from an edge dictionary","request":{"name":"Get an item from an edge dictionary","description":"Retrieve a single DictionaryItem given service, dictionary ID and item key.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/dictionary/{{dictionary_id}}/item/{{dictionary_item_key}}","path":["service","{{service_id}}","dictionary","{{dictionary_id}}","item","{{dictionary_item_key}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"dictionary_id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"item_key\":\"test-key\",\"item_value\":\"test-value\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null,\"updated_at\":\"2020-04-21T18:14:32.000Z\"}","originalRequest":{"name":"Get an item from an edge dictionary","description":"Retrieve a single DictionaryItem given service, dictionary ID and item key.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/dictionary/3vjTN8v1O7nOAY7aNDGOL/item/test-key","path":["service","SU1Z0isxPaozGVKXdv0eY","dictionary","3vjTN8v1O7nOAY7aNDGOL","item","test-key"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Insert or update an entry in an edge dictionary","request":{"name":"Insert or update an entry in an edge dictionary","description":"Upsert DictionaryItem given service, dictionary ID, item key, and item value.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/dictionary/{{dictionary_id}}/item/{{dictionary_item_key}}","path":["service","{{service_id}}","dictionary","{{dictionary_id}}","item","{{dictionary_item_key}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"dictionary_id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"item_key\":\"test-key\",\"item_value\":\"test-value\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null,\"updated_at\":\"2020-04-21T18:14:32.000Z\"}","originalRequest":{"name":"Insert or update an entry in an edge dictionary","description":"Upsert DictionaryItem given service, dictionary ID, item key, and item value.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/dictionary/3vjTN8v1O7nOAY7aNDGOL/item/test-key","path":["service","SU1Z0isxPaozGVKXdv0eY","dictionary","3vjTN8v1O7nOAY7aNDGOL","item","test-key"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete an item from an edge dictionary","request":{"name":"Delete an item from an edge dictionary","description":"Delete DictionaryItem given service, dictionary ID, and item key.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/dictionary/{{dictionary_id}}/item/{{dictionary_item_key}}","path":["service","{{service_id}}","dictionary","{{dictionary_id}}","item","{{dictionary_item_key}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete an item from an edge dictionary","description":"Delete DictionaryItem given service, dictionary ID, and item key.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/dictionary/3vjTN8v1O7nOAY7aNDGOL/item/test-key","path":["service","SU1Z0isxPaozGVKXdv0eY","dictionary","3vjTN8v1O7nOAY7aNDGOL","item","test-key"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update an entry in an edge dictionary","request":{"name":"Update an entry in an edge dictionary","description":"Update DictionaryItem given service, dictionary ID, item key, and item value.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/service/{{service_id}}/dictionary/{{dictionary_id}}/item/{{dictionary_item_key}}","path":["service","{{service_id}}","dictionary","{{dictionary_id}}","item","{{dictionary_item_key}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"dictionary_id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"item_key\":\"test-key\",\"item_value\":\"test-value\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null,\"updated_at\":\"2020-04-21T18:14:32.000Z\"}","originalRequest":{"name":"Update an entry in an edge dictionary","description":"Update DictionaryItem given service, dictionary ID, item key, and item value.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/dictionary/3vjTN8v1O7nOAY7aNDGOL/item/test-key","path":["service","SU1Z0isxPaozGVKXdv0eY","dictionary","3vjTN8v1O7nOAY7aNDGOL","item","test-key"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Create an entry in an edge dictionary","request":{"name":"Create an entry in an edge dictionary","description":"Create DictionaryItem given service, dictionary ID, item key, and item value.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/dictionary/{{dictionary_id}}/item","path":["service","{{service_id}}","dictionary","{{dictionary_id}}","item"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"dictionary_id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"item_key\":\"test-key\",\"item_value\":\"test-value\",\"created_at\":\"2020-04-21T18:14:32.000Z\",\"deleted_at\":null,\"updated_at\":\"2020-04-21T18:14:32.000Z\"}","originalRequest":{"name":"Create an entry in an edge dictionary","description":"Create DictionaryItem given service, dictionary ID, item key, and item value.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/dictionary/3vjTN8v1O7nOAY7aNDGOL/item","path":["service","SU1Z0isxPaozGVKXdv0eY","dictionary","3vjTN8v1O7nOAY7aNDGOL","item"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Dictionary","description":"A Dictionary is a VCL data table that stores key-value pairs accessible to VCL during request processing. New, empty dictionaries can be attached to a draft version of a service, which must be activated for the dictionary to be included in VCL. Once installed, a dictionary's items may be updated via API calls without having to activate a new version of the associated service configuration. To remove a dictionary, delete it on a draft version of a service (one that is not locked and not active). Once removed, activate the draft service version without the dictionary.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| name | string | Name for the Dictionary (must start with an alphabetic character and can contain only alphanumeric characters, underscores, and whitespace). |\n| write_only | boolean | Determines if items in the dictionary are readable or not. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying a Dictionary. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List edge dictionaries","request":{"name":"List edge dictionaries","description":"List all dictionaries for the version of the service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/dictionary","path":["service","{{service_id}}","version","{{version_id}}","dictionary"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"created_at\":\"2020-04-29T22:16:23.000Z\",\"deleted_at\":null,\"id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"name\":\"test-dictionary\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-04-29T22:16:23.000Z\",\"version\":1,\"write_only\":false}]","originalRequest":{"name":"List edge dictionaries","description":"List all dictionaries for the version of the service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/dictionary","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","dictionary"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create an edge dictionary","request":{"name":"Create an edge dictionary","description":"Create named dictionary for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/dictionary","path":["service","{{service_id}}","version","{{version_id}}","dictionary"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-04-29T22:16:23.000Z\",\"deleted_at\":null,\"id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"name\":\"test-dictionary\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-04-29T22:16:23.000Z\",\"version\":1,\"write_only\":false}","originalRequest":{"name":"Create an edge dictionary","description":"Create named dictionary for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/dictionary","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","dictionary"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get an edge dictionary","request":{"name":"Get an edge dictionary","description":"Retrieve a single dictionary by name for the version and service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/dictionary/{{dictionary_name}}","path":["service","{{service_id}}","version","{{version_id}}","dictionary","{{dictionary_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-04-29T22:16:23.000Z\",\"deleted_at\":null,\"id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"name\":\"test-dictionary\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-04-29T22:16:23.000Z\",\"version\":1,\"write_only\":false}","originalRequest":{"name":"Get an edge dictionary","description":"Retrieve a single dictionary by name for the version and service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/dictionary/test_dictionary","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","dictionary","test_dictionary"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update an edge dictionary","request":{"name":"Update an edge dictionary","description":"Update named dictionary for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/dictionary/{{dictionary_name}}","path":["service","{{service_id}}","version","{{version_id}}","dictionary","{{dictionary_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-04-29T22:16:23.000Z\",\"deleted_at\":null,\"id\":\"3vjTN8v1O7nOAY7aNDGOL\",\"name\":\"test-dictionary\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-04-29T22:16:23.000Z\",\"version\":1,\"write_only\":false}","originalRequest":{"name":"Update an edge dictionary","description":"Update named dictionary for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/dictionary/test_dictionary","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","dictionary","test_dictionary"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete an edge dictionary","request":{"name":"Delete an edge dictionary","description":"Delete named dictionary for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/dictionary/{{dictionary_name}}","path":["service","{{service_id}}","version","{{version_id}}","dictionary","{{dictionary_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete an edge dictionary","description":"Delete named dictionary for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/dictionary/test_dictionary","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","dictionary","test_dictionary"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}]},{"name":"Legacy WAF","item":[{"name":"Configuration sets","description":"Configuration sets are used to view and select the available versions of the Fastly WAF rules.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| active | boolean | The active configuration set is the default configuration set when creating a new WAF. When Fastly adds configuration sets, the new versions become the default (active). |\n| name | string | The name of the configuration set. |","item":[{"name":"List configuration sets","request":{"name":"List configuration sets","description":"List all Configuration sets.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/wafs/configuration_sets","path":["wafs","configuration_sets"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"Cf9g2uUGZzb2W9Euo4m0oR\",\"type\":\"configuration_set\",\"attributes\":{\"active\":true,\"name\":\"v2 2020-04-17T21:04:00+00:00\"}},{\"id\":\"Cf9g2uUGZzbuo5q2Azm0oA\",\"type\":\"configuration_set\",\"attributes\":{\"active\":false,\"name\":\"v1 2020-02-17T21:04:00+00:00\"}}],\"links\":{\"last\":\"http://api.fastly.com/wafs/configuration_sets?page[number]=1&page[size]=100\",\"first\":\"http://api.fastly.com/wafs/configuration_sets?page[number]=1&page[size]=100\"}}","originalRequest":{"name":"List configuration sets","description":"List all Configuration sets.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/wafs/configuration_sets","path":["wafs","configuration_sets"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"List WAFs currently using a configuration set","request":{"name":"List WAFs currently using a configuration set","description":"List the WAF objects currently using the specified configuration set.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/wafs/configuration_sets/{{configuration_set_id}}/relationships/wafs","path":["wafs","configuration_sets","{{configuration_set_id}}","relationships","wafs"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\"}],\"links\":{\"first\":\"http://api.fastly.com/wafs/configuration_sets/Cf9g2uUGZzb2W9Euo4m0oR/relationships/wafs?page[number]=1&page[size]=100\",\"last\":\"http://api.fastly.com/wafs/configuration_sets/Cf9g2uUGZzb2W9Euo4m0oR/relationships/wafs?page[number]=1&page[size]=100\"}}","originalRequest":{"name":"List WAFs currently using a configuration set","description":"List the WAF objects currently using the specified configuration set.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/wafs/configuration_sets/Cf9g2uUGZzb2W9Euo4m0oR/relationships/wafs","path":["wafs","configuration_sets","Cf9g2uUGZzb2W9Euo4m0oR","relationships","wafs"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Apply a configuration set to a WAF","request":{"name":"Apply a configuration set to a WAF","description":"Update one or more WAF objects to use the specified configuration set.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/wafs/configuration_sets/{{configuration_set_id}}/relationships/wafs","path":["wafs","configuration_sets","{{configuration_set_id}}","relationships","wafs"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":[{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\"},{\"id\":\"w4Fg2uUGZzb2W9Euo5q2Az\",\"type\":\"waf\"}]}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\"},{\"id\":\"w4Fg2uUGZzb2W9Euo5q2Az\",\"type\":\"waf\"}],\"links\":{\"first\":\"http://api.fastly.com/wafs/configuration_sets/Cf9g2uUGZzb2W9Euo4m0oR/relationships/wafs?page[number]=1&page[size]=100\",\"last\":\"http://api.fastly.com/wafs/configuration_sets/Cf9g2uUGZzb2W9Euo4m0oR/relationships/wafs?page[number]=1&page[size]=100\"}}","originalRequest":{"name":"Apply a configuration set to a WAF","description":"Update one or more WAF objects to use the specified configuration set.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/wafs/configuration_sets/Cf9g2uUGZzb2W9Euo4m0oR/relationships/wafs","path":["wafs","configuration_sets","Cf9g2uUGZzb2W9Euo4m0oR","relationships","wafs"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":[{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\"},{\"id\":\"w4Fg2uUGZzb2W9Euo5q2Az\",\"type\":\"waf\"}]}"}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Firewall","description":"Firewall object used when configuring WAF.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| disabled | boolean | The status of the firewall. |\n| last_push | string | Date and time that VCL was last pushed to cache nodes. |\n| prefetch_condition | string | Name of the corresponding condition object. |\n| response | string | Name of the corresponding response object. |\n| rule_statuses_block_count | integer | The number of rule statuses set to block. |\n| rule_statuses_disabled_count | integer | The number of rule statuses set to disabled. |\n| rule_statuses_log_count | integer | The number of rule statuses set to log. |\n| service_id | string | Alphanumeric string identifying the service. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List firewalls","request":{"name":"List firewalls","description":"List all firewall objects for a particular service and version.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/wafs","path":["service","{{service_id}}","version","{{version_id}}","wafs"],"host":["{{fastly_url}}"],"query":[{"key":"include","description":"Include relationships. Optional, comma separated values. Permitted values: configuration_set, owasp."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\",\"attributes\":{\"prefetch_condition\":null,\"response\":\"waf\",\"last_push\":\"2020-09-28 22:52:33 UTC\",\"version\":1,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"disabled\":false,\"rule_statuses_log_count\":235,\"rule_statuses_block_count\":34,\"rule_statuses_disabled_count\":2},\"relationships\":{\"configuration_set\":{\"data\":{\"id\":\"Cf9g2uUGZzb2W9Euo4m0oR\",\"type\":\"configuration_set\"}}}}],\"links\":{\"first\":\"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/VERSION/wafs?page[number]=1&page[size]=100\",\"last\":\"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/VERSION/wafs?page[number]=1&page[size]=100\"}}","originalRequest":{"name":"List firewalls","description":"List all firewall objects for a particular service and version.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/wafs?include=configuration_set&page%5Bnumber%5D=1&page%5Bsize%5D=20","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","wafs?include=configuration_set&page%5Bnumber%5D=1&page%5Bsize%5D=20"],"host":["https://api.fastly.com"],"query":[{"key":"include","description":"Include relationships. Optional, comma separated values. Permitted values: configuration_set, owasp."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a firewall","request":{"name":"Create a firewall","description":"Create a firewall object for a particular service and version.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/wafs","path":["service","{{service_id}}","version","{{version_id}}","wafs"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"waf\",\"attributes\":{\"prefetch_condition\":\"WAF-Condition\",\"response\":\"WAF_Error\"}}}"}},"response":[{"status":"201 Created","name":"201 Created","code":201,"header":[],"body":"{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\",\"attributes\":{\"last_push\":null,\"prefetch_condition\":\"WAF-Condition\",\"response\":\"WAF_Error\",\"version\":1,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"disabled\":false,\"rule_statuses_log_count\":235,\"rule_statuses_block_count\":34,\"rule_statuses_disabled_count\":2},\"relationships\":{\"configuration_set\":{\"data\":{\"id\":\"Cf9g2uUGZzb2W9Euo4m0oR\",\"type\":\"configuration_set\"}}}}}","originalRequest":{"name":"Create a firewall","description":"Create a firewall object for a particular service and version.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/wafs","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","wafs"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"waf\",\"attributes\":{\"prefetch_condition\":\"WAF-Condition\",\"response\":\"WAF_Error\"}}}"}}}]},{"name":"Get a firewall","request":{"name":"Get a firewall","description":"Get a specific firewall object.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/wafs/{{firewall_id}}","path":["service","{{service_id}}","version","{{version_id}}","wafs","{{firewall_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\",\"attributes\":{\"last_push\":\"2020-08-16 17:05:13 UTC\",\"prefetch_condition\":\"WAF-Condition\",\"response\":\"WAF_Error\",\"version\":1,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"disabled\":false,\"rule_statuses_log_count\":235,\"rule_statuses_block_count\":34,\"rule_statuses_disabled_count\":2},\"relationships\":{\"configuration_set\":{\"data\":{\"id\":\"Cf9g2uUGZzb2W9Euo4m0oR\",\"type\":\"configuration_set\"}}}}}","originalRequest":{"name":"Get a firewall","description":"Get a specific firewall object.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/wafs/fW7g2uUGZzb2W9Euo4Mo0r","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","wafs","fW7g2uUGZzb2W9Euo4Mo0r"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a firewall","request":{"name":"Update a firewall","description":"Update a firewall object for a particular service and version.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/wafs/{{firewall_id}}","path":["service","{{service_id}}","version","{{version_id}}","wafs","{{firewall_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\",\"attributes\":{\"response\":\"new response\"}}}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\",\"attributes\":{\"last_push\":null,\"prefetch_condition\":\"WAF-Condition\",\"response\":\"new response\",\"version\":1,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"disabled\":false,\"rule_statuses_log_count\":235,\"rule_statuses_block_count\":34,\"rule_statuses_disabled_count\":2},\"relationships\":{\"configuration_set\":{\"data\":{\"id\":\"Cf9g2uUGZzb2W9Euo4m0oR\",\"type\":\"configuration_set\"}}}}}","originalRequest":{"name":"Update a firewall","description":"Update a firewall object for a particular service and version.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/wafs/fW7g2uUGZzb2W9Euo4Mo0r","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","wafs","fW7g2uUGZzb2W9Euo4Mo0r"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\",\"attributes\":{\"response\":\"new response\"}}}"}}}]},{"name":"Disable a firewall","request":{"name":"Disable a firewall","description":"Disable a firewall for a particular service and version. This endpoint is intended to be used in an emergency. Disabling a firewall object for a specific service and version replaces your existing WAF ruleset with an empty ruleset. While disabled, your WAF ruleset will not be applied to your origin traffic. This endpoint is only available to users assigned the role of superuser or above. This is an asynchronous action. To check on the completion of this action, use the related link returned in the response to check on the Update Status of the action.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/wafs/{{firewall_id}}/disable","path":["wafs","{{firewall_id}}","disable"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\"}}"}},"response":[{"status":"202 Accepted","name":"202 Accepted","code":202,"header":[],"body":"{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\",\"attributes\":{\"last_push\":null,\"prefetch_condition\":null,\"response\":null,\"version\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"disabled\":false,\"rule_statuses_log_count\":235,\"rule_statuses_block_count\":34,\"rule_statuses_disabled_count\":2},\"relationships\":{\"configuration_set\":{\"data\":{\"id\":\"Cf9g2uUGZzb2W9Euo4m0oR\",\"type\":\"configuration_set\"}}},\"links\":{\"related\":{\"href\":\"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/WAF_ID/update_statuses/Up5SguUGZzb2W9Euo4moOr\"}}}}","originalRequest":{"name":"Disable a firewall","description":"Disable a firewall for a particular service and version. This endpoint is intended to be used in an emergency. Disabling a firewall object for a specific service and version replaces your existing WAF ruleset with an empty ruleset. While disabled, your WAF ruleset will not be applied to your origin traffic. This endpoint is only available to users assigned the role of superuser or above. This is an asynchronous action. To check on the completion of this action, use the related link returned in the response to check on the Update Status of the action.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/wafs/fW7g2uUGZzb2W9Euo4Mo0r/disable","path":["wafs","fW7g2uUGZzb2W9Euo4Mo0r","disable"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\"}}"}}}]},{"name":"Enable a firewall","request":{"name":"Enable a firewall","description":"Re-enable a firewall object for a particular service and version after it has been disabled. This endpoint is intended to be used in an emergency. When a firewall object is re-enabled, a newly generated WAF ruleset VCL based on the current WAF configuration is used to replace the empty ruleset. This endpoint is only available to users assigned the role of superuser or above. This is an asynchronous action. To check on the completion of this action, use the related link returned in the response to check on the Update Status of the action.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/wafs/{{firewall_id}}/enable","path":["wafs","{{firewall_id}}","enable"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\"}}"}},"response":[{"status":"202 Accepted","name":"202 Accepted","code":202,"header":[],"body":"{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\",\"attributes\":{\"last_push\":null,\"prefetch_condition\":null,\"response\":null,\"version\":1,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"disabled\":false,\"rule_statuses_log_count\":235,\"rule_statuses_block_count\":34,\"rule_statuses_disabled_count\":2},\"relationships\":{\"configuration_set\":{\"data\":{\"id\":\"Cf9g2uUGZzb2W9Euo4m0oR\",\"type\":\"configuration_set\"}}},\"links\":{\"related\":{\"href\":\"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/WAF_ID/update_statuses/Up5SguUGZzb2W9Euo4moOr\"}}}}","originalRequest":{"name":"Enable a firewall","description":"Re-enable a firewall object for a particular service and version after it has been disabled. This endpoint is intended to be used in an emergency. When a firewall object is re-enabled, a newly generated WAF ruleset VCL based on the current WAF configuration is used to replace the empty ruleset. This endpoint is only available to users assigned the role of superuser or above. This is an asynchronous action. To check on the completion of this action, use the related link returned in the response to check on the Update Status of the action.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Superuser](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/wafs/fW7g2uUGZzb2W9Euo4Mo0r/enable","path":["wafs","fW7g2uUGZzb2W9Euo4Mo0r","enable"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\"}}"}}}]},{"name":"List active firewalls","request":{"name":"List active firewalls","description":"List all active firewall objects.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/wafs","path":["wafs"],"host":["{{fastly_url}}"],"query":[{"key":"filter[rules][rule_id]","description":"Limit the returned firewalls to a specific rule ID."},{"key":"include","description":"Include relationships. Optional, comma separated values. Permitted values: configuration_set, owasp."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\",\"attributes\":{\"prefetch_condition\":null,\"response\":\"waf\",\"last_push\":\"2020-09-28 22:52:33 UTC\",\"disabled\":false,\"version\":2,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"rule_statuses_log_count\":235,\"rule_statuses_block_count\":34,\"rule_statuses_disabled_count\":2},\"relationships\":{\"configuration_set\":{\"data\":{\"id\":\"Cf9g2uUGZzb2W9Euo4m0oR\",\"type\":\"configuration_set\"}}}}],\"links\":{\"first\":\"https://api.fastly.com/wafs?page[number]=1&page[size]=100\",\"last\":\"https://api.fastly.com/wafs?page[number]=1&page[size]=100\"}}","originalRequest":{"name":"List active firewalls","description":"List all active firewall objects.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/wafs?include=configuration_set&page%5Bnumber%5D=1&page%5Bsize%5D=20","path":["wafs?include=configuration_set&page%5Bnumber%5D=1&page%5Bsize%5D=20"],"host":["https://api.fastly.com"],"query":[{"key":"filter[rules][rule_id]","description":"Limit the returned firewalls to a specific rule ID."},{"key":"include","description":"Include relationships. Optional, comma separated values. Permitted values: configuration_set, owasp."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get a firewall object","request":{"name":"Get a firewall object","description":"Get a specific firewall object.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/wafs/{{firewall_id}}","path":["wafs","{{firewall_id}}"],"host":["{{fastly_url}}"],"query":[{"key":"include","description":"Include relationships. Optional, comma separated values. Permitted values: configuration_set, owasp, rules, rule_statuses."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\",\"attributes\":{\"last_push\":\"2020-08-16 17:05:13 UTC\",\"prefetch_condition\":\"WAF-Condition\",\"response\":\"WAF_Error\",\"version\":\"1\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"disabled\":false,\"rule_statuses_log_count\":235,\"rule_statuses_block_count\":34,\"rule_statuses_disabled_count\":2},\"relationships\":{\"configuration_set\":{\"data\":{\"id\":\"Cf9g2uUGZzb2W9Euo4m0oR\",\"type\":\"configuration_set\"}}}}}","originalRequest":{"name":"Get a firewall object","description":"Get a specific firewall object.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/wafs/fW7g2uUGZzb2W9Euo4Mo0r?include=configuration_set","path":["wafs","fW7g2uUGZzb2W9Euo4Mo0r?include=configuration_set"],"host":["https://api.fastly.com"],"query":[{"key":"include","description":"Include relationships. Optional, comma separated values. Permitted values: configuration_set, owasp, rules, rule_statuses."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"OWASP","description":"OWASP settings object used when configuring WAF.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| allowed_http_versions | string | Allowed HTTP versions. |\n| allowed_methods | string | A space-separated list of HTTP method names. |\n| allowed_request_content_type | string | Allowed request content types. |\n| arg_length | integer | The maximum allowed length of an argument. |\n| arg_name_length | integer | The maximum allowed argument name length. |\n| combined_file_sizes | integer | The maximum allowed size of all files (in bytes). |\n| created_at | string | Date and time that the settings object was created. |\n| critical_anomaly_score | integer | Score value to add for critical anomalies. |\n| crs_validate_utf8_encoding | boolean | CRS validate UTF8 encoding. |\n| error_anomaly_score | integer | Score value to add for error anomalies. |\n| high_risk_country_codes | string | A space-separated list of country codes in ISO 3166-1 (two-letter) format. |\n| http_violation_score_threshold | integer | HTTP violation threshold. |\n| inbound_anomaly_score_threshold | integer | Inbound anomaly threshold. |\n| lfi_score_threshold | integer | Local file inclusion attack threshold. |\n| max_file_size | integer | The maximum allowed file size (in bytes). |\n| max_num_args | integer | The maximum number of arguments allowed. |\n| notice_anomaly_score | integer | Score value to add for notice anomalies. |\n| paranoia_level | integer | The configured paranoia level. |\n| php_injection_score_threshold | integer | PHP injection threshold. |\n| rce_score_threshold | integer | Remote code execution threshold. |\n| restricted_extensions | string | A space-separated list of disallowed file extensions. |\n| restricted_headers | string | A space-separated list of disallowed header names. |\n| rfi_score_threshold | integer | Remote file inclusion attack threshold. |\n| session_fixation_score_threshold | integer | Session fixation attack threshold. |\n| sql_injection_score_threshold | integer | SQL injection attack threshold. |\n| total_arg_length | integer | The maximum size of argument names and values. |\n| updated_at | string | Date and time that the settings object was last updated. |\n| warning_anomaly_score | integer | Score value to add for warning anomalies. |\n| xss_score_threshold | integer | XSS attack threshold. |","item":[{"name":"Get the OWASP settings object","request":{"name":"Get the OWASP settings object","description":"Get the OWASP settings object for a particular service and firewall.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/wafs/{{firewall_id}}/owasp","path":["service","{{service_id}}","wafs","{{firewall_id}}","owasp"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"0W4guUGZzb2W9Euo4m0oR\",\"type\":\"owasp\",\"attributes\":{\"allowed_http_versions\":\"HTTP/1.0 HTTP/1.1 HTTP/2\",\"allowed_methods\":\"GET HEAD POST OPTIONS PUT PATCH DELETE\",\"allowed_request_content_type\":\"application/x-www-form-urlencoded|multipart/form-data|text/xml|application/xml|application/x-amf|application/json|text/plain\",\"arg_length\":400,\"arg_name_length\":100,\"combined_file_sizes\":10000000,\"created_at\":\"2020-09-09 16:00:17 UTC\",\"critical_anomaly_score\":6,\"crs_validate_utf8_encoding\":false,\"error_anomaly_score\":5,\"high_risk_country_codes\":null,\"http_violation_score_threshold\":999,\"inbound_anomaly_score_threshold\":999,\"lfi_score_threshold\":999,\"max_file_size\":10000000,\"max_num_args\":null,\"notice_anomaly_score\":4,\"paranoia_level\":1,\"php_injection_score_threshold\":999,\"rce_score_threshold\":999,\"restricted_extensions\":\".asa/ .asax/ .ascx/ .axd/ .backup/ .bak/ .bat/ .cdx/ .cer/ .cfg/ .cmd/ .com/ .config/ .conf/ .cs/ .csproj/ .csr/ .dat/ .db/ .dbf/ .dll/ .dos/ .htr/ .htw/ .ida/ .idc/ .idq/ .inc/ .ini/ .key/ .licx/ .lnk/ .log/ .mdb/ .old/ .pass/ .pdb/ .pol/ .printer/ .pwd/ .resources/ .resx/ .sql/ .sys/ .vb/ .vbs/ .vbproj/ .vsdisco/ .webinfo/ .xsd/ .xsx\",\"restricted_headers\":\"/proxy/ /lock-token/ /content-range/ /translate/ /if/\",\"rfi_score_threshold\":999,\"session_fixation_score_threshold\":999,\"sql_injection_score_threshold\":999,\"total_arg_length\":6400,\"updated_at\":\"2020-09-09 16:00:17 UTC\",\"warning_anomaly_score\":3,\"xss_score_threshold\":999},\"relationships\":{\"waf\":{\"data\":{\"type\":\"waf\",\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\"}}}}}","originalRequest":{"name":"Get the OWASP settings object","description":"Get the OWASP settings object for a particular service and firewall.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/fW7g2uUGZzb2W9Euo4Mo0r/owasp","path":["service","SU1Z0isxPaozGVKXdv0eY","wafs","fW7g2uUGZzb2W9Euo4Mo0r","owasp"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create an OWASP settings object","request":{"name":"Create an OWASP settings object","description":"Create an OWASP settings object for a particular service and firewall.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/wafs/{{firewall_id}}/owasp","path":["service","{{service_id}}","wafs","{{firewall_id}}","owasp"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"owasp\"}}"}},"response":[{"status":"201 Created","name":"201 Created","code":201,"header":[],"body":"{\"data\":{\"id\":\"0W4guUGZzb2W9Euo4m0oR\",\"type\":\"owasp\",\"attributes\":{\"allowed_http_versions\":\"HTTP/1.0 HTTP/1.1 HTTP/2\",\"allowed_methods\":\"GET HEAD POST OPTIONS PUT PATCH DELETE\",\"allowed_request_content_type\":\"application/x-www-form-urlencoded|multipart/form-data|text/xml|application/xml|application/x-amf|application/json|text/plain\",\"arg_length\":400,\"arg_name_length\":100,\"combined_file_sizes\":10000000,\"created_at\":\"2020-09-09 16:00:17 UTC\",\"critical_anomaly_score\":6,\"crs_validate_utf8_encoding\":false,\"error_anomaly_score\":5,\"high_risk_country_codes\":null,\"http_violation_score_threshold\":999,\"inbound_anomaly_score_threshold\":999,\"lfi_score_threshold\":999,\"max_file_size\":10000000,\"max_num_args\":null,\"notice_anomaly_score\":4,\"paranoia_level\":1,\"php_injection_score_threshold\":999,\"rce_score_threshold\":999,\"restricted_extensions\":\".asa/ .asax/ .ascx/ .axd/ .backup/ .bak/ .bat/ .cdx/ .cer/ .cfg/ .cmd/ .com/ .config/ .conf/ .cs/ .csproj/ .csr/ .dat/ .db/ .dbf/ .dll/ .dos/ .htr/ .htw/ .ida/ .idc/ .idq/ .inc/ .ini/ .key/ .licx/ .lnk/ .log/ .mdb/ .old/ .pass/ .pdb/ .pol/ .printer/ .pwd/ .resources/ .resx/ .sql/ .sys/ .vb/ .vbs/ .vbproj/ .vsdisco/ .webinfo/ .xsd/ .xsx\",\"restricted_headers\":\"/proxy/ /lock-token/ /content-range/ /translate/ /if/\",\"rfi_score_threshold\":999,\"session_fixation_score_threshold\":999,\"sql_injection_score_threshold\":999,\"total_arg_length\":6400,\"updated_at\":\"2020-09-09 16:00:17 UTC\",\"warning_anomaly_score\":3,\"xss_score_threshold\":999},\"relationships\":{\"waf\":{\"data\":{\"type\":\"waf\",\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\"}}}}}","originalRequest":{"name":"Create an OWASP settings object","description":"Create an OWASP settings object for a particular service and firewall.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/fW7g2uUGZzb2W9Euo4Mo0r/owasp","path":["service","SU1Z0isxPaozGVKXdv0eY","wafs","fW7g2uUGZzb2W9Euo4Mo0r","owasp"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"owasp\"}}"}}}]},{"name":"Update the OWASP settings object","request":{"name":"Update the OWASP settings object","description":"Update the OWASP settings object for a particular service and firewall.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/service/{{service_id}}/wafs/{{firewall_id}}/owasp","path":["service","{{service_id}}","wafs","{{firewall_id}}","owasp"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"id\":\"0W4guUGZzb2W9Euo4m0oR\",\"type\":\"owasp\",\"attributes\":{\"inbound_anomaly_score_threshold\":42}}}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"0W4guUGZzb2W9Euo4m0oR\",\"type\":\"owasp\",\"attributes\":{\"allowed_http_versions\":\"HTTP/1.0 HTTP/1.1 HTTP/2\",\"allowed_methods\":\"GET HEAD POST OPTIONS PUT PATCH DELETE\",\"allowed_request_content_type\":\"application/x-www-form-urlencoded|multipart/form-data|text/xml|application/xml|application/x-amf|application/json|text/plain\",\"arg_length\":400,\"arg_name_length\":100,\"combined_file_sizes\":10000000,\"created_at\":\"2020-09-09 16:00:17 UTC\",\"critical_anomaly_score\":6,\"crs_validate_utf8_encoding\":false,\"error_anomaly_score\":5,\"high_risk_country_codes\":null,\"http_violation_score_threshold\":999,\"inbound_anomaly_score_threshold\":999,\"lfi_score_threshold\":999,\"max_file_size\":10000000,\"max_num_args\":null,\"notice_anomaly_score\":4,\"paranoia_level\":1,\"php_injection_score_threshold\":999,\"rce_score_threshold\":999,\"restricted_extensions\":\".asa/ .asax/ .ascx/ .axd/ .backup/ .bak/ .bat/ .cdx/ .cer/ .cfg/ .cmd/ .com/ .config/ .conf/ .cs/ .csproj/ .csr/ .dat/ .db/ .dbf/ .dll/ .dos/ .htr/ .htw/ .ida/ .idc/ .idq/ .inc/ .ini/ .key/ .licx/ .lnk/ .log/ .mdb/ .old/ .pass/ .pdb/ .pol/ .printer/ .pwd/ .resources/ .resx/ .sql/ .sys/ .vb/ .vbs/ .vbproj/ .vsdisco/ .webinfo/ .xsd/ .xsx\",\"restricted_headers\":\"/proxy/ /lock-token/ /content-range/ /translate/ /if/\",\"rfi_score_threshold\":999,\"session_fixation_score_threshold\":999,\"sql_injection_score_threshold\":999,\"total_arg_length\":6400,\"updated_at\":\"2020-09-09 16:00:17 UTC\",\"warning_anomaly_score\":3,\"xss_score_threshold\":999},\"relationships\":{\"waf\":{\"data\":{\"type\":\"waf\",\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\"}}}}}","originalRequest":{"name":"Update the OWASP settings object","description":"Update the OWASP settings object for a particular service and firewall.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/fW7g2uUGZzb2W9Euo4Mo0r/owasp","path":["service","SU1Z0isxPaozGVKXdv0eY","wafs","fW7g2uUGZzb2W9Euo4Mo0r","owasp"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"id\":\"0W4guUGZzb2W9Euo4m0oR\",\"type\":\"owasp\",\"attributes\":{\"inbound_anomaly_score_threshold\":42}}}"}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Rule statuses","description":"A Rule status represents the status of a particular rule for a given firewall. For a rule to be attached to a particular firewall and performing any actions, a rule status must exist.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| modsec_rule_id | string | The ModSecurity rule ID. |\n| status | string | Describes the behavior for the particular rule within this firewall. Permitted values: log, block, and disabled. |\n| unique_rule_id | string | The Rule ID. |","item":[{"name":"List rule statuses","request":{"name":"List rule statuses","description":"List all rule statuses for a particular service and firewall.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/wafs/{{firewall_id}}/rule_statuses","path":["service","{{service_id}}","wafs","{{firewall_id}}","rule_statuses"],"host":["{{fastly_url}}"],"query":[{"key":"filter[rule][message]","description":"Limit results to rule statuses whose rules have the specified message."},{"key":"filter[rule][rule_id]","description":"Limit results to rule statuses whose rules represent the specified ModSecurity rule_id."},{"key":"filter[rule][tags][name]","description":"Limit results to rule statuses whose rules related to the named tags."},{"key":"filter[rule][tags]","description":"Limit results to rule statuses whose rules relate to the specified tag IDs."},{"key":"filter[status]","description":"Limit results to rule statuses with the specified status."},{"key":"include","description":"Include relationships. Optional, comma separated values. Permitted values: tags."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"links\":{\"last\":\"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/WAF_ID/rule_statuses?page[number]=1&page[size]=100\",\"first\":\"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/WAF_ID/rule_statuses?page[number]=1&page[size]=100\"},\"data\":[{\"id\":\"RU1S0isxPaozGVKXdv0eY\",\"type\":\"rule_status\",\"attributes\":{\"status\":\"log\",\"unique_rule_id\":\"3krg2uUGZzb2W9Euo4moOR\",\"modsec_rule_id\":2500162},\"relationships\":{\"waf\":{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\"}},\"rule\":{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule\"}}}},{\"id\":\"RU1S0isxPaozGVKXdv0eY\",\"type\":\"rule_status\",\"attributes\":{\"status\":\"disabled\",\"unique_rule_id\":\"3krg2uUGZzb2W9Euo4moOR\",\"modsec_rule_id\":2500162},\"relationships\":{\"waf\":{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\"}},\"rule\":{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule\"}}}},{\"id\":\"RU1S0isxPaozGVKXdv0eY\",\"type\":\"rule_status\",\"attributes\":{\"status\":\"log\",\"unique_rule_id\":\"3krg2uUGZzb2W9Euo4moOR\",\"modsec_rule_id\":2500162},\"relationships\":{\"waf\":{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\"}},\"rule\":{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule\"}}}}]}","originalRequest":{"name":"List rule statuses","description":"List all rule statuses for a particular service and firewall.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/fW7g2uUGZzb2W9Euo4Mo0r/rule_statuses?filter%5Brule%5D%5Btags%5D%5Bname%5D=application-FBC+Market&page%5Bnumber%5D=1&page%5Bsize%5D=20","path":["service","SU1Z0isxPaozGVKXdv0eY","wafs","fW7g2uUGZzb2W9Euo4Mo0r","rule_statuses?filter%5Brule%5D%5Btags%5D%5Bname%5D=application-FBC+Market&page%5Bnumber%5D=1&page%5Bsize%5D=20"],"host":["https://api.fastly.com"],"query":[{"key":"filter[rule][message]","description":"Limit results to rule statuses whose rules have the specified message."},{"key":"filter[rule][rule_id]","description":"Limit results to rule statuses whose rules represent the specified ModSecurity rule_id."},{"key":"filter[rule][tags][name]","description":"Limit results to rule statuses whose rules related to the named tags."},{"key":"filter[rule][tags]","description":"Limit results to rule statuses whose rules relate to the specified tag IDs."},{"key":"filter[status]","description":"Limit results to rule statuses with the specified status."},{"key":"include","description":"Include relationships. Optional, comma separated values. Permitted values: tags."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create or update status of a tagged group of rules","request":{"name":"Create or update status of a tagged group of rules","description":"Create or update all rule statuses for a particular service and firewall, based on tag name. By default, only rule status for enabled rules (with status log or block) will be updated. To update rule statuses for disabled rules under the specified tag, use the force attribute.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/wafs/{{firewall_id}}/rule_statuses","path":["service","{{service_id}}","wafs","{{firewall_id}}","rule_statuses"],"host":["{{fastly_url}}"],"query":[{"key":"force","description":"Whether or not to update rule statuses for disabled rules. Optional."},{"key":"name","description":"The tag name to use to determine the set of rules to update. For example, OWASP or language-php."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"rule_status\",\"attributes\":{\"status\":\"block\",\"name\":\"application-FBC Market\",\"force\":true}}}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"RU1S0isxPaozGVKXdv0eY\",\"type\":\"rule_status\",\"attributes\":{\"status\":\"block\",\"unique_rule_id\":\"3krg2uUGZzb2W9Euo4moOR\",\"modsec_rule_id\":2500162},\"relationships\":{\"waf\":{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\"}},\"rule\":{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule\"}}}}]}","originalRequest":{"name":"Create or update status of a tagged group of rules","description":"Create or update all rule statuses for a particular service and firewall, based on tag name. By default, only rule status for enabled rules (with status log or block) will be updated. To update rule statuses for disabled rules under the specified tag, use the force attribute.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/fW7g2uUGZzb2W9Euo4Mo0r/rule_statuses","path":["service","SU1Z0isxPaozGVKXdv0eY","wafs","fW7g2uUGZzb2W9Euo4Mo0r","rule_statuses"],"host":["https://api.fastly.com"],"query":[{"key":"force","description":"Whether or not to update rule statuses for disabled rules. Optional."},{"key":"name","description":"The tag name to use to determine the set of rules to update. For example, OWASP or language-php."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"rule_status\",\"attributes\":{\"status\":\"block\",\"name\":\"application-FBC Market\",\"force\":true}}}"}}}]},{"name":"Get the status of a rule on a firewall","request":{"name":"Get the status of a rule on a firewall","description":"Get a specific rule status object for a particular service, firewall, and rule.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/wafs/{{firewall_id}}/rules/{{waf_rule_id}}/rule_status","path":["service","{{service_id}}","wafs","{{firewall_id}}","rules","{{waf_rule_id}}","rule_status"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"RU1S0isxPaozGVKXdv0eY\",\"type\":\"rule_status\",\"attributes\":{\"status\":\"log\",\"unique_rule_id\":\"3krg2uUGZzb2W9Euo4moOR\",\"modsec_rule_id\":2500162},\"relationships\":{\"rule\":{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule\"}]},\"waf\":{\"data\":[{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\"}]}}}}","originalRequest":{"name":"Get the status of a rule on a firewall","description":"Get a specific rule status object for a particular service, firewall, and rule.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/fW7g2uUGZzb2W9Euo4Mo0r/rules/3krg2uUGZzb2W9Euo4moOR/rule_status","path":["service","SU1Z0isxPaozGVKXdv0eY","wafs","fW7g2uUGZzb2W9Euo4Mo0r","rules","3krg2uUGZzb2W9Euo4moOR","rule_status"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update the status of a rule","request":{"name":"Update the status of a rule","description":"Update a rule status for a particular service, firewall, and rule.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/service/{{service_id}}/wafs/{{firewall_id}}/rules/{{waf_rule_id}}/rule_status","path":["service","{{service_id}}","wafs","{{firewall_id}}","rules","{{waf_rule_id}}","rule_status"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"id\":\"RU1S0isxPaozGVKXdv0eY\",\"type\":\"rule_status\",\"attributes\":{\"status\":\"block\"}}}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"RU1S0isxPaozGVKXdv0eY\",\"type\":\"rule_status\",\"attributes\":{\"status\":\"block\",\"unique_rule_id\":\"3krg2uUGZzb2W9Euo4moOR\",\"modsec_rule_id\":2500162}}}","originalRequest":{"name":"Update the status of a rule","description":"Update a rule status for a particular service, firewall, and rule.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/fW7g2uUGZzb2W9Euo4Mo0r/rules/3krg2uUGZzb2W9Euo4moOR/rule_status","path":["service","SU1Z0isxPaozGVKXdv0eY","wafs","fW7g2uUGZzb2W9Euo4Mo0r","rules","3krg2uUGZzb2W9Euo4moOR","rule_status"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"id\":\"RU1S0isxPaozGVKXdv0eY\",\"type\":\"rule_status\",\"attributes\":{\"status\":\"block\"}}}"}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Rules","description":"Rules used when configuring WAF.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| message | string | Message metadata for the rule. |\n| rule_id | string | Corresponding ModSecurity rule ID. |\n| severity | integer | Severity metadata for the rule. |\n| source | string | The ModSecurity rule logic. |\n| vcl | string | The VCL representation of the rule logic. |","item":[{"name":"List rules in the latest configuration set","request":{"name":"List rules in the latest configuration set","description":"List all rules in the latest configuration set.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/wafs/rules","path":["wafs","rules"],"host":["{{fastly_url}}"],"query":[{"key":"filter[configuration_set_id]","description":"Optional. Limit rules to specific configuration set or pass \"all\" to search all configuration sets, including stale ones."},{"key":"filter[rule_id]","description":"Limit the returned rules to a specific rule ID."},{"key":"filter[severity]","description":"Limit the returned rules to a specific severity."},{"key":"filter[tags][name]","description":"Limit the returned rules to a set linked to a tag by name."},{"key":"include","description":"Include relationships. Optional. Comma separated values. Permitted values: tags, rule_statuses, and source."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"data\":[{\"type\":\"rule\",\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"attributes\":{\"rule_id\":2500162,\"severity\":2,\"message\":\"Cross-site Scripting (XSS) Anomaly Threshold Exceeded (XSS Score: %{TX.XSS_SCORE})\",\"source\":null,\"vcl\":null}}],\"links\":{\"last\":\"https://api.fastly.com/wafs/rules?page[number]=204&page[size]=1\",\"first\":\"https://api.fastly.com/wafs/rules?page[number]=1&page[size]=1\",\"next\":\"https://api.fastly.com/wafs/rules?page[number]=2&page[size]=1\"}}]","originalRequest":{"name":"List rules in the latest configuration set","description":"List all rules in the latest configuration set.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/wafs/rules?page%5Bnumber%5D=1&page%5Bsize%5D=20","path":["wafs","rules?page%5Bnumber%5D=1&page%5Bsize%5D=20"],"host":["https://api.fastly.com"],"query":[{"key":"filter[configuration_set_id]","description":"Optional. Limit rules to specific configuration set or pass \"all\" to search all configuration sets, including stale ones."},{"key":"filter[rule_id]","description":"Limit the returned rules to a specific rule ID."},{"key":"filter[severity]","description":"Limit the returned rules to a specific severity."},{"key":"filter[tags][name]","description":"Limit the returned rules to a set linked to a tag by name."},{"key":"include","description":"Include relationships. Optional. Comma separated values. Permitted values: tags, rule_statuses, and source."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get a rule","request":{"name":"Get a rule","description":"Get a specific rule.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/wafs/rules/{{waf_rule_id}}","path":["wafs","rules","{{waf_rule_id}}"],"host":["{{fastly_url}}"],"query":[{"key":"filter[configuration_set_id]","description":"Optional. Limit rule to a specific configuration set or pass \"all\" to search all configuration sets, including stale ones."},{"key":"include","description":"Include relationships. Optional. Comma separated values. Permitted values: tags, rule_statuses, source, and vcl."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule\",\"attributes\":{\"message\":\"SLR: Xpoze account/user/mail.html reed Parameter SQL Injection\",\"rule_id\":2500162,\"severity\":2},\"relationships\":{\"tags\":{\"data\":[{\"id\":\"t4Gg2uUGZzb2W9Euo4mo0R\",\"type\":\"tag\"}]}}}}","originalRequest":{"name":"Get a rule","description":"Get a specific rule.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/wafs/rules/3krg2uUGZzb2W9Euo4moOR?include=tags","path":["wafs","rules","3krg2uUGZzb2W9Euo4moOR?include=tags"],"host":["https://api.fastly.com"],"query":[{"key":"filter[configuration_set_id]","description":"Optional. Limit rule to a specific configuration set or pass \"all\" to search all configuration sets, including stale ones."},{"key":"include","description":"Include relationships. Optional. Comma separated values. Permitted values: tags, rule_statuses, source, and vcl."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get VCL for a rule","request":{"name":"Get VCL for a rule","description":"Get associated VCL for a specific rule.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/wafs/rules/{{waf_rule_id}}/vcl","path":["wafs","rules","{{waf_rule_id}}","vcl"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule_vcl\",\"attributes\":{\"vcl\":\"sub waf_ruleset {\\n  declare local var.postbody STRING;\\n  set var.postbody = req.postbody;\\n\\n  workspace.snapshot;\\n\\n  set waf.rule_id = 943011;\\n\\n  call waf_debug_log;\\n  workspace.restore;\\n  goto WAF_MARKER_0;\\n\\n  workspace.restore;\\n\\n  if (waf.blocked || waf.logged) {\\n    return;\\n  }\\n}\\n\"},\"relationships\":{\"rule\":{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule\"}}}}}","originalRequest":{"name":"Get VCL for a rule","description":"Get associated VCL for a specific rule.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/wafs/rules/3krg2uUGZzb2W9Euo4moOR/vcl","path":["wafs","rules","3krg2uUGZzb2W9Euo4moOR","vcl"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get VCL for a rule associated with a firewall","request":{"name":"Get VCL for a rule associated with a firewall","description":"Get associated VCL for a specific rule associated with a specific firewall.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/wafs/{{firewall_id}}/rules/{{waf_rule_id}}/vcl","path":["wafs","{{firewall_id}}","rules","{{waf_rule_id}}","vcl"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule_vcl\",\"attributes\":{\"vcl\":\"/*\\n\\nThis is a report of changes to the rules you have configured when generating\\n\\nVCL. Rules may be edited or removed depending on the configuration of your\\n\\nWAF.\\n\\nParanoiaFilter:\\n\\n    943011: removed due to being above paranoia level 1\\n*/\\n\\nsub waf_ruleset {\\n  declare local var.postbody STRING;\\n  set var.postbody = req.postbody;\\n\\n  if (waf.blocked || waf.logged) {\\n    return;\\n  }\\n}\\n\"},\"relationships\":{\"rule\":{\"data\":{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule\"}}}}}","originalRequest":{"name":"Get VCL for a rule associated with a firewall","description":"Get associated VCL for a specific rule associated with a specific firewall.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/wafs/fW7g2uUGZzb2W9Euo4Mo0r/rules/3krg2uUGZzb2W9Euo4moOR/vcl","path":["wafs","fW7g2uUGZzb2W9Euo4Mo0r","rules","3krg2uUGZzb2W9Euo4moOR","vcl"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Rule sets","description":"Retrieve the currently deployed WAF ruleset VCL and the date it was deployed.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| last_push | string | Date and time WAF ruleset VCL was last deployed. |\n| vcl | string | The WAF ruleset VCL currently deployed. |","item":[{"name":"Get a WAF ruleset","request":{"name":"Get a WAF ruleset","description":"Get a WAF ruleset for a particular service and firewall object.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/wafs/{{firewall_id}}/ruleset","path":["service","{{service_id}}","wafs","{{firewall_id}}","ruleset"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"r5TguUGZzb2W9EuF4mo0N\",\"type\":\"ruleset\",\"attributes\":{\"last_push\":\"2020-08-16 17:05:13 UTC\",\"vcl\":\"sub waf_ruleset {\\n\\n}\\n\"}}}","originalRequest":{"name":"Get a WAF ruleset","description":"Get a WAF ruleset for a particular service and firewall object.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/fW7g2uUGZzb2W9Euo4Mo0r/ruleset","path":["service","SU1Z0isxPaozGVKXdv0eY","wafs","fW7g2uUGZzb2W9Euo4Mo0r","ruleset"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a WAF ruleset","request":{"name":"Update a WAF ruleset","description":"Update the WAF ruleset for a particular service and firewall object. Use the URL in the response to view the WAF ruleset deploy status.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/service/{{service_id}}/wafs/{{firewall_id}}/ruleset","path":["service","{{service_id}}","wafs","{{firewall_id}}","ruleset"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"id\":\"r5TguUGZzb2W9EuF4mo0N\",\"type\":\"ruleset\"}}"}},"response":[{"status":"202 Accepted","name":"202 Accepted","code":202,"header":[],"body":"{\"data\":{\"id\":\"r5TguUGZzb2W9EuF4mo0N\",\"type\":\"ruleset\"},\"links\":{\"related\":{\"href\":\"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/WAF_ID/update_statuses/Up5SguUGZzb2W9Euo4moOr\"}}}","originalRequest":{"name":"Update a WAF ruleset","description":"Update the WAF ruleset for a particular service and firewall object. Use the URL in the response to view the WAF ruleset deploy status.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/fW7g2uUGZzb2W9Euo4Mo0r/ruleset","path":["service","SU1Z0isxPaozGVKXdv0eY","wafs","fW7g2uUGZzb2W9Euo4Mo0r","ruleset"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"id\":\"r5TguUGZzb2W9EuF4mo0N\",\"type\":\"ruleset\"}}"}}}]},{"name":"Generate WAF ruleset VCL","request":{"name":"Generate WAF ruleset VCL","description":"Get a preview of the WAF ruleset VCL for a particular service and firewall object based on changes to WAF configuration before deploying the ruleset. The response will include a link to status of the background VCL generation job. Once the background job is completed, the preview WAF ruleset VCL can be retrieved from the status response.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/wafs/{{firewall_id}}/ruleset/preview","path":["service","{{service_id}}","wafs","{{firewall_id}}","ruleset","preview"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"202 Accepted","name":"202 Accepted","code":202,"header":[],"body":"{\"data\":{\"id\":\"r5TguUGZzb2W9EuF4mo0N\",\"type\":\"ruleset\",\"attributes\":{},\"links\":{\"related\":{\"href\":\"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/WAF_ID/update_statuses/Up5SguUGZzb2W9Euo4moOr\"}},\"meta\":{\"warnings\":{\"title\":\"Generating preview ruleset VCL for w4Fg2uUGZzb2W9Euo4m0Or\",\"detail\":\"Please check the data field for generated preview VCL once the background job completes.\"}}}}","originalRequest":{"name":"Generate WAF ruleset VCL","description":"Get a preview of the WAF ruleset VCL for a particular service and firewall object based on changes to WAF configuration before deploying the ruleset. The response will include a link to status of the background VCL generation job. Once the background job is completed, the preview WAF ruleset VCL can be retrieved from the status response.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/fW7g2uUGZzb2W9Euo4Mo0r/ruleset/preview","path":["service","SU1Z0isxPaozGVKXdv0eY","wafs","fW7g2uUGZzb2W9Euo4Mo0r","ruleset","preview"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Tags","description":"Tags for categorizing WAF rules. Tags can be filtered by name.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| name | string | Name of the tag. |","item":[{"name":"List WAF tags","request":{"name":"List WAF tags","description":"List all tags.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/wafs/tags","path":["wafs","tags"],"host":["{{fastly_url}}"],"query":[{"key":"filter[name]","description":"Limit the returned tags to a specific name."},{"key":"include","description":"Include relationships. Optional, comma separated values. Permitted values: rules."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"links\":{\"next\":\"https://api.fastly.com/wafs/tags?page[number]=2&page[size]=100\",\"last\":\"https://api.fastly.com/wafs/tags?page[number]=201&page[size]=100\",\"first\":\"https://api.fastly.com/wafs/tags?page[number]=1&page[size]=100\"},\"data\":[{\"id\":\"t4Gg2uUGZzb2W9Euo4mo0R\",\"type\":\"tag\",\"attributes\":{\"name\":\"OWASP\"},\"relationships\":{\"rules\":{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule\"},{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule\"},{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule\"},{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule\"}]}}},{\"id\":\"t4Gg2uUGZzb2W9Euo4mo0R\",\"type\":\"tag\",\"attributes\":{\"name\":\"WASCTC/WASC-37\"},\"relationships\":{\"rules\":{\"data\":[{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule\"},{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule\"},{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule\"},{\"id\":\"3krg2uUGZzb2W9Euo4moOR\",\"type\":\"rule\"}]}}}]}","originalRequest":{"name":"List WAF tags","description":"List all tags.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/wafs/tags?include=rules&page%5Bnumber%5D=1&page%5Bsize%5D=20","path":["wafs","tags?include=rules&page%5Bnumber%5D=1&page%5Bsize%5D=20"],"host":["https://api.fastly.com"],"query":[{"key":"filter[name]","description":"Limit the returned tags to a specific name."},{"key":"include","description":"Include relationships. Optional, comma separated values. Permitted values: rules."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Update statuses","description":"Update status indicates the status of an asynchronous process for updating a firewall object.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| completed_at | string | Date and time that job was completed. |\n| created_at | string | Date and time that job was created. |\n| data | string | This field can contain data passed to the background worker as well as output from the background job. |\n| message | string | Message with information about the status of the update. |\n| status | string | Current status of the update. |\n| updated_at | string | Date and time that job was last updated. |","item":[{"name":"List update statuses","request":{"name":"List update statuses","description":"List all update statuses for a particular service and firewall object.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/wafs/{{firewall_id}}/update_statuses","path":["service","{{service_id}}","wafs","{{firewall_id}}","update_statuses"],"host":["{{fastly_url}}"],"query":[{"key":"include","description":"Include relationships. Optional, comma separated values. Permitted values: waf."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"links\":{\"last\":\"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/WAF_ID/update_statuses\",\"next\":\"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/WAF_ID/update_statuses\",\"first\":\"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/WAF_ID/update_statuses\"},\"data\":[{\"id\":\"Up5SguUGZzb2W9Euo4moOr\",\"type\":\"waf_update_status\",\"attributes\":{\"created_at\":\"2020-09-28 21:01:29 UTC\",\"status\":\"complete\",\"data\":null,\"message\":null,\"completed_at\":\"2020-09-28 21:01:30 UTC\",\"updated_at\":\"2020-09-28 21:01:30 UTC\"},\"relationships\":{\"waf\":{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\"}}}},{\"id\":\"Up5SguUGZzb2W9Euo4moOr\",\"type\":\"waf_update_status\",\"attributes\":{\"status\":\"complete\",\"created_at\":\"2020-09-27 23:09:50 UTC\",\"completed_at\":\"2020-09-27 23:09:50 UTC\",\"message\":null,\"data\":null,\"updated_at\":\"2020-09-27 23:09:50 UTC\"},\"relationships\":{\"waf\":{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\"}}}}]}","originalRequest":{"name":"List update statuses","description":"List all update statuses for a particular service and firewall object.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/fW7g2uUGZzb2W9Euo4Mo0r/update_statuses?include=waf&page%5Bnumber%5D=1&page%5Bsize%5D=20","path":["service","SU1Z0isxPaozGVKXdv0eY","wafs","fW7g2uUGZzb2W9Euo4Mo0r","update_statuses?include=waf&page%5Bnumber%5D=1&page%5Bsize%5D=20"],"host":["https://api.fastly.com"],"query":[{"key":"include","description":"Include relationships. Optional, comma separated values. Permitted values: waf."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get the status of a WAF update","request":{"name":"Get the status of a WAF update","description":"Get a specific update status object for a particular service and firewall object.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/wafs/{{firewall_id}}/update_statuses/{{update_status_id}}","path":["service","{{service_id}}","wafs","{{firewall_id}}","update_statuses","{{update_status_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"Up5SguUGZzb2W9Euo4moOr\",\"type\":\"waf_update_status\",\"attributes\":{\"completed_at\":\"2020-09-09 16:10:49 UTC\",\"created_at\":\"2020-09-09 16:10:49 UTC\",\"data\":null,\"message\":null,\"status\":\"complete\",\"updated_at\":\"2020-09-09 16:10:49 UTC\"},\"relationships\":{\"waf\":{\"data\":{\"id\":\"w4Fg2uUGZzb2W9Euo4m0Or\",\"type\":\"waf\"}}}}}","originalRequest":{"name":"Get the status of a WAF update","description":"Get a specific update status object for a particular service and firewall object.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/wafs/fW7g2uUGZzb2W9Euo4Mo0r/update_statuses/Up5SguUGZzb2W9Euo4moOr","path":["service","SU1Z0isxPaozGVKXdv0eY","wafs","fW7g2uUGZzb2W9Euo4Mo0r","update_statuses","Up5SguUGZzb2W9Euo4moOr"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}]},{"name":"Real-time logging","item":[{"name":"Microsoft Azure Blob Storage","description":"Fastly will upload log messages to the Azure Blob Storage container in the format specified in the Azure Blob object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| account_name | string | The unique Azure Blob Storage namespace in which your data objects are stored. Required. |\n| compression_codec | string | The codec used for compressing your logs. Valid values are zstd, snappy, and gzip. Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| container | string | The name of the Azure Blob Storage container in which to store logs. Required. |\n| file_max_bytes | integer | The maximum number of bytes for each uploaded file. A value of 0 can be used to indicate there is no limit on the size of uploaded files, otherwise the minimum value is 1048576 bytes (1 MiB.). |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| gzip_level | integer | The level of gzip encoding when sending logs (default 0, no compression). Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| message_type | string | How the message should be formatted. |\n|  | classic | RFC 3164 syslog prefix. |\n|  | loggly | RFC 5424 structured syslog. |\n|  | logplex | Heroku-style length prefixed syslog. |\n|  | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| path | string | The path to upload logs to. |\n| period | integer | How frequently log files are finalized so they can be available for reading (in seconds). |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| sas_token | string | The Azure shared access signature providing write access to the blob service objects. Be sure to update your token before it expires or the logging functionality will not work. Required. |\n| timestamp_format | string | A timestamp format. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List Azure Blob Storage log endpoints","request":{"name":"List Azure Blob Storage log endpoints","description":"List all of the Azure Blob Storage logging endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/azureblob","path":["service","{{service_id}}","version","{{version_id}}","logging","azureblob"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"placement\":null,\"format_version\":2,\"sas_token\":\"sv=2020-09-05&sr=b&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D&se=2020-09-30T02%3A23%3A26Z&sp=rw\",\"compression_codec\":\"zstd\",\"gzip_level\":0,\"response_condition\":\"\",\"public_key\":null,\"updated_at\":\"2020-09-12T20:49:16.000Z\",\"message_type\":\"classic\",\"period\":3600,\"name\":\"test-log-endpoint\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"container\":\"test-container\",\"path\":null,\"deleted_at\":null,\"account_name\":\"test-account\",\"created_at\":\"2020-09-12T20:49:16.000Z\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"file_max_bytes\":100000000}]","originalRequest":{"name":"List Azure Blob Storage log endpoints","description":"List all of the Azure Blob Storage logging endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/azureblob","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","azureblob"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create an Azure Blob Storage log endpoint","request":{"name":"Create an Azure Blob Storage log endpoint","description":"Create an Azure Blob Storage logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/azureblob","path":["service","{{service_id}}","version","{{version_id}}","logging","azureblob"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"format_version\":2,\"sas_token\":\"sv=2020-09-05&sr=b&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D&se=2020-09-30T02%3A23%3A26Z&sp=rw\",\"compression_codec\":\"zstd\",\"gzip_level\":0,\"response_condition\":\"\",\"public_key\":null,\"updated_at\":\"2020-09-12T20:49:16.000Z\",\"message_type\":\"classic\",\"period\":3600,\"name\":\"test-log-endpoint\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"container\":\"test-container\",\"path\":null,\"deleted_at\":null,\"account_name\":\"test-account\",\"created_at\":\"2020-09-12T20:49:16.000Z\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"file_max_bytes\":100000000}","originalRequest":{"name":"Create an Azure Blob Storage log endpoint","description":"Create an Azure Blob Storage logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/azureblob","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","azureblob"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get an Azure Blob Storage log endpoint","request":{"name":"Get an Azure Blob Storage log endpoint","description":"Get the Azure Blob Storage logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/azureblob/{{logging_azureblob_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","azureblob","{{logging_azureblob_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"format_version\":2,\"sas_token\":\"sv=2020-09-05&sr=b&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D&se=2020-09-30T02%3A23%3A26Z&sp=rw\",\"compression_codec\":\"zstd\",\"gzip_level\":0,\"response_condition\":\"\",\"public_key\":null,\"updated_at\":\"2020-09-12T20:49:16.000Z\",\"message_type\":\"classic\",\"period\":3600,\"name\":\"test-log-endpoint\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"container\":\"test-container\",\"path\":null,\"deleted_at\":null,\"account_name\":\"test-account\",\"created_at\":\"2020-09-12T20:49:16.000Z\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"file_max_bytes\":100000000}","originalRequest":{"name":"Get an Azure Blob Storage log endpoint","description":"Get the Azure Blob Storage logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/azureblob/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","azureblob","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update an Azure Blob Storage log endpoint","request":{"name":"Update an Azure Blob Storage log endpoint","description":"Update the Azure Blob Storage logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/azureblob/{{logging_azureblob_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","azureblob","{{logging_azureblob_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"format_version\":2,\"sas_token\":\"sv=2020-09-05&sr=b&sig=Z%2FRHIX5Xcg0Mq2rqI3OlWTjEg2tYkboXr1P9ZUXDtkk%3D&se=2020-09-30T02%3A23%3A26Z&sp=rw\",\"compression_codec\":\"zstd\",\"gzip_level\":0,\"response_condition\":\"\",\"public_key\":null,\"updated_at\":\"2020-09-12T20:49:16.000Z\",\"message_type\":\"classic\",\"period\":3600,\"name\":\"updated-test-log-endpoint\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"container\":\"test-container\",\"path\":null,\"deleted_at\":null,\"account_name\":\"test-account\",\"created_at\":\"2020-09-12T20:49:16.000Z\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"file_max_bytes\":100000000}","originalRequest":{"name":"Update an Azure Blob Storage log endpoint","description":"Update the Azure Blob Storage logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/azureblob/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","azureblob","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete the Azure Blob Storage log endpoint","request":{"name":"Delete the Azure Blob Storage log endpoint","description":"Delete the Azure Blob Storage logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/azureblob/{{logging_azureblob_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","azureblob","{{logging_azureblob_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete the Azure Blob Storage log endpoint","description":"Delete the Azure Blob Storage logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/azureblob/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","azureblob","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"BigQuery","description":"Fastly will upload log messages to the Google BigQuery dataset and table in the format specified in the BigQuery logging object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| dataset | string | Your BigQuery dataset. |\n| format | string | A Fastly log format string. Must produce JSON that matches the schema of your BigQuery table. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| name | string | The name of the BigQuery logging object. Used as a primary key for API access. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| project_id | string | Your Google Cloud Platform project ID. Required. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| secret_key | string | Your Google Cloud Platform account secret key. The private_key field in your service account authentication JSON. Required. |\n| table | string | Your BigQuery table. |\n| template_suffix | string | BigQuery table name suffix template. Optional. |\n| user | string | Your Google Cloud Platform service account email address. The client_email field in your service account authentication JSON. Required. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List BigQuery log endpoints","request":{"name":"List BigQuery log endpoints","description":"List all of the BigQuery logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/bigquery","path":["service","{{service_id}}","version","{{version_id}}","logging","bigquery"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":2,\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"project_id\":\"test-project-id\",\"dataset\":\"test-dataset\",\"table\":\"test-table\",\"template_suffix\":null,\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}]","originalRequest":{"name":"List BigQuery log endpoints","description":"List all of the BigQuery logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/bigquery","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","bigquery"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a BigQuery log endpoint","request":{"name":"Create a BigQuery log endpoint","description":"Create a BigQuery logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/bigquery","path":["service","{{service_id}}","version","{{version_id}}","logging","bigquery"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":2,\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"project_id\":\"test-project-id\",\"dataset\":\"test-dataset\",\"table\":\"test-table\",\"template_suffix\":null,\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}","originalRequest":{"name":"Create a BigQuery log endpoint","description":"Create a BigQuery logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/bigquery","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","bigquery"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a BigQuery log endpoint","request":{"name":"Get a BigQuery log endpoint","description":"Get the details for a BigQuery logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/bigquery/{{logging_bigquery_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","bigquery","{{logging_bigquery_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":2,\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"project_id\":\"test-project-id\",\"dataset\":\"test-dataset\",\"table\":\"test-table\",\"template_suffix\":null,\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}","originalRequest":{"name":"Get a BigQuery log endpoint","description":"Get the details for a BigQuery logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/bigquery/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","bigquery","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a BigQuery log endpoint","request":{"name":"Update a BigQuery log endpoint","description":"Update a BigQuery logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/bigquery/{{logging_bigquery_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","bigquery","{{logging_bigquery_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"updated-test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":2,\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"project_id\":\"test-project-id\",\"dataset\":\"test-dataset\",\"table\":\"test-table\",\"template_suffix\":null,\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}","originalRequest":{"name":"Update a BigQuery log endpoint","description":"Update a BigQuery logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/bigquery/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","bigquery","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a BigQuery log endpoint","request":{"name":"Delete a BigQuery log endpoint","description":"Delete a BigQuery logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/bigquery/{{logging_bigquery_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","bigquery","{{logging_bigquery_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a BigQuery log endpoint","description":"Delete a BigQuery logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/bigquery/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","bigquery","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Cloud Files","description":"Fastly will upload log messages to your Rackspace Cloud Files account.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| access_key | string | Your Cloud Files account access key. |\n| bucket_name | string | The name of your Cloud Files container. |\n| compression_codec | string | The codec used for compressing your logs. Valid values are zstd, snappy, and gzip. Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| gzip_level | integer | The level of gzip encoding when sending logs (default 0, no compression). Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| message_type | string | How the message should be formatted. |\n|  | classic | RFC 3164 syslog prefix. |\n|  | loggly | RFC 5424 structured syslog. |\n|  | logplex | Heroku-style length prefixed syslog. |\n|  | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| path | string | The path to upload logs to. |\n| period | integer | How frequently log files are finalized so they can be available for reading (in seconds). |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. |\n| region | string | The region to stream logs to. |\n|  | DFW | Dallas. |\n|  | ORD | Chicago. |\n|  | IAD | Northern Virginia. |\n|  | LON | London. |\n|  | SYD | Sydney. |\n|  | HKG | Hong Kong. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| timestamp_format | string | A timestamp format. |\n| user | string | The username for your Cloud Files account. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List Cloud Files log endpoints","request":{"name":"List Cloud Files log endpoints","description":"List all of the Cloud Files log endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/cloudfiles","path":["service","{{service_id}}","version","{{version_id}}","logging","cloudfiles"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"compression_codec\":\"zstd\",\"gzip_level\":0,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"bucket_name\":\"test-bucket\",\"user\":\"test-user\",\"created_at\":\"2020-05-21T22:49:44.000Z\",\"public_key\":null,\"response_condition\":\"\",\"name\":\"test-log-endpoint\",\"period\":3600,\"region\":null,\"deleted_at\":null,\"message_type\":\"classic\",\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"updated_at\":\"2020-05-21T22:49:44.000Z\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"version\":1,\"path\":null,\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"placement\":null,\"format_version\":2}]","originalRequest":{"name":"List Cloud Files log endpoints","description":"List all of the Cloud Files log endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/cloudfiles","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","cloudfiles"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a Cloud Files log endpoint","request":{"name":"Create a Cloud Files log endpoint","description":"Create a Cloud Files log endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/cloudfiles","path":["service","{{service_id}}","version","{{version_id}}","logging","cloudfiles"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"compression_codec\":\"zstd\",\"gzip_level\":0,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"bucket_name\":\"test-bucket\",\"user\":\"test-user\",\"created_at\":\"2020-05-21T22:49:44.000Z\",\"public_key\":null,\"response_condition\":\"\",\"name\":\"test-log-endpoint\",\"period\":3600,\"region\":null,\"deleted_at\":null,\"message_type\":\"classic\",\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"updated_at\":\"2020-05-21T22:49:44.000Z\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"version\":1,\"path\":null,\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"placement\":null,\"format_version\":2}","originalRequest":{"name":"Create a Cloud Files log endpoint","description":"Create a Cloud Files log endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/cloudfiles","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","cloudfiles"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a Cloud Files log endpoint","request":{"name":"Get a Cloud Files log endpoint","description":"Get the Cloud Files log endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/cloudfiles/{{logging_cloudfiles_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","cloudfiles","{{logging_cloudfiles_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"compression_codec\":\"zstd\",\"gzip_level\":0,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"bucket_name\":\"test-bucket\",\"user\":\"test-user\",\"created_at\":\"2020-05-21T22:49:44.000Z\",\"public_key\":null,\"response_condition\":\"\",\"name\":\"test-log-endpoint\",\"period\":3600,\"region\":null,\"deleted_at\":null,\"message_type\":\"classic\",\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"updated_at\":\"2020-05-21T22:49:44.000Z\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"version\":1,\"path\":null,\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"placement\":null,\"format_version\":2}","originalRequest":{"name":"Get a Cloud Files log endpoint","description":"Get the Cloud Files log endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/cloudfiles/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","cloudfiles","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update the Cloud Files log endpoint","request":{"name":"Update the Cloud Files log endpoint","description":"Update the Cloud Files log endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/cloudfiles/{{logging_cloudfiles_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","cloudfiles","{{logging_cloudfiles_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"compression_codec\":\"zstd\",\"gzip_level\":0,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"bucket_name\":\"test-bucket\",\"user\":\"test-user\",\"created_at\":\"2020-05-21T22:49:44.000Z\",\"public_key\":null,\"response_condition\":\"\",\"name\":\"updated-test-log-endpoint\",\"period\":3600,\"region\":null,\"deleted_at\":null,\"message_type\":\"classic\",\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"updated_at\":\"2020-05-21T22:49:44.000Z\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"version\":1,\"path\":null,\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"placement\":null,\"format_version\":2}","originalRequest":{"name":"Update the Cloud Files log endpoint","description":"Update the Cloud Files log endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/cloudfiles/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","cloudfiles","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete the Cloud Files log endpoint","request":{"name":"Delete the Cloud Files log endpoint","description":"Delete the Cloud Files log endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/cloudfiles/{{logging_cloudfiles_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","cloudfiles","{{logging_cloudfiles_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete the Cloud Files log endpoint","description":"Delete the Cloud Files log endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/cloudfiles/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","cloudfiles","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Datadog","description":"Fastly will upload log messages to Datadog in the format specified in the Datadog configuration object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| format | string | A Fastly log format string. Must produce valid JSON that Datadog can ingest. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| region | string | The region that log data will be sent to. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| token | string | The API key from your Datadog account. Required. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List Datadog log endpoints","request":{"name":"List Datadog log endpoints","description":"List all of the Datadog logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/datadog","path":["service","{{service_id}}","version","{{version_id}}","logging","datadog"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"region\":\"US\",\"format\":\"{\\\"ddsource\\\":\\\"fastly\\\",\\\"service\\\":\\\"%{req.service_id}V\\\",\\\"date\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"time_start\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"time_end\\\":\\\"%{end:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"http\\\":{\\\"request_time_ms\\\":\\\"%D\\\",\\\"method\\\":\\\"%m\\\",\\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\\"useragent\\\":\\\"%{User-Agent}i\\\",\\\"referer\\\":\\\"%{Referer}i\\\",\\\"protocol\\\":\\\"%H\\\",\\\"request_x_forwarded_for\\\":\\\"%{X-Forwarded-For}i\\\",\\\"status_code\\\":\\\"%s\\\"},\\\"network\\\":{\\\"client\\\":{\\\"ip\\\":\\\"%h\\\",\\\"name\\\":\\\"%{client.as.name}V\\\",\\\"number\\\":\\\"%{client.as.number}V\\\",\\\"connection_speed\\\":\\\"%{client.geo.conn_speed}V\\\"},\\\"destination\\\":{\\\"ip\\\":\\\"%A\\\"},\\\"geoip\\\":{\\\"geo_city\\\":\\\"%{client.geo.city.utf8}V\\\",\\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\\"geo_continent_code\\\":\\\"%{client.geo.continent_code}V\\\",\\\"geo_region\\\":\\\"%{client.geo.region}V\\\"},\\\"bytes_written\\\":\\\"%B\\\",\\\"bytes_read\\\":\\\"%{req.body_bytes_read}V\\\"},\\\"host\\\":\\\"%{Fastly-Orig-Host}i\\\",\\\"origin_host\\\":\\\"%v\\\",\\\"is_ipv6\\\":\\\"%{if(req.is_ipv6, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"is_tls\\\":\\\"%{if(req.is_ssl, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"tls_client_protocol\\\":\\\"%{json.escape(tls.client.protocol)}V\\\",\\\"tls_client_servername\\\":\\\"%{json.escape(tls.client.servername)}V\\\",\\\"tls_client_cipher\\\":\\\"%{json.escape(tls.client.cipher)}V\\\",\\\"tls_client_cipher_sha\\\":\\\"%{json.escape(tls.client.ciphers_sha)}V\\\",\\\"tls_client_tlsexts_sha\\\":\\\"%{json.escape(tls.client.tlsexts_sha)}V\\\",\\\"is_h2\\\":\\\"%{if(fastly_info.is_h2, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"is_h2_push\\\":\\\"%{if(fastly_info.h2.is_push, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"h2_stream_id\\\":\\\"%{fastly_info.h2.stream_id}V\\\",\\\"request_accept_content\\\":\\\"%{Accept}i\\\",\\\"request_accept_language\\\":\\\"%{Accept-Language}i\\\",\\\"request_accept_encoding\\\":\\\"%{Accept-Encoding}i\\\",\\\"request_accept_charset\\\":\\\"%{Accept-Charset}i\\\",\\\"request_connection\\\":\\\"%{Connection}i\\\",\\\"request_dnt\\\":\\\"%{DNT}i\\\",\\\"request_forwarded\\\":\\\"%{Forwarded}i\\\",\\\"request_via\\\":\\\"%{Via}i\\\",\\\"request_cache_control\\\":\\\"%{Cache-Control}i\\\",\\\"request_x_requested_with\\\":\\\"%{X-Requested-With}i\\\",\\\"request_x_att_device_id\\\":\\\"%{X-ATT-Device-Id}i\\\",\\\"content_type\\\":\\\"%{Content-Type}o\\\",\\\"is_cacheable\\\":\\\"%{if(fastly_info.state~\\\\\\\"^(HIT|MISS)$\\\\\\\", \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"response_age\\\":\\\"%{Age}o\\\",\\\"response_cache_control\\\":\\\"%{Cache-Control}o\\\",\\\"response_expires\\\":\\\"%{Expires}o\\\",\\\"response_last_modified\\\":\\\"%{Last-Modified}o\\\",\\\"response_tsv\\\":\\\"%{TSV}o\\\",\\\"server_datacenter\\\":\\\"%{server.datacenter}V\\\",\\\"req_header_size\\\":\\\"%{req.header_bytes_read}V\\\",\\\"resp_header_size\\\":\\\"%{resp.header_bytes_written}V\\\",\\\"socket_cwnd\\\":\\\"%{client.socket.cwnd}V\\\",\\\"socket_nexthop\\\":\\\"%{client.socket.nexthop}V\\\",\\\"socket_tcpi_rcv_mss\\\":\\\"%{client.socket.tcpi_rcv_mss}V\\\",\\\"socket_tcpi_snd_mss\\\":\\\"%{client.socket.tcpi_snd_mss}V\\\",\\\"socket_tcpi_rtt\\\":\\\"%{client.socket.tcpi_rtt}V\\\",\\\"socket_tcpi_rttvar\\\":\\\"%{client.socket.tcpi_rttvar}V\\\",\\\"socket_tcpi_rcv_rtt\\\":\\\"%{client.socket.tcpi_rcv_rtt}V\\\",\\\"socket_tcpi_rcv_space\\\":\\\"%{client.socket.tcpi_rcv_space}V\\\",\\\"socket_tcpi_last_data_sent\\\":\\\"%{client.socket.tcpi_last_data_sent}V\\\",\\\"socket_tcpi_total_retrans\\\":\\\"%{client.socket.tcpi_total_retrans}V\\\",\\\"socket_tcpi_delta_retrans\\\":\\\"%{client.socket.tcpi_delta_retrans}V\\\",\\\"socket_ploss\\\":\\\"%{client.socket.ploss}V\\\"}\",\"format_version\":2,\"created_at\":\"2020-04-22T16:50:01.000Z\",\"updated_at\":\"2020-04-22T16:50:01.000Z\",\"deleted_at\":null,\"response_condition\":\"\",\"placement\":null,\"token\":\"DD-API-KEY\"}]","originalRequest":{"name":"List Datadog log endpoints","description":"List all of the Datadog logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/datadog","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","datadog"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a Datadog log endpoint","request":{"name":"Create a Datadog log endpoint","description":"Create a Datadog logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/datadog","path":["service","{{service_id}}","version","{{version_id}}","logging","datadog"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"region\":\"US\",\"format\":\"{\\\"ddsource\\\":\\\"fastly\\\",\\\"service\\\":\\\"%{req.service_id}V\\\",\\\"date\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"time_start\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"time_end\\\":\\\"%{end:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"http\\\":{\\\"request_time_ms\\\":\\\"%D\\\",\\\"method\\\":\\\"%m\\\",\\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\\"useragent\\\":\\\"%{User-Agent}i\\\",\\\"referer\\\":\\\"%{Referer}i\\\",\\\"protocol\\\":\\\"%H\\\",\\\"request_x_forwarded_for\\\":\\\"%{X-Forwarded-For}i\\\",\\\"status_code\\\":\\\"%s\\\"},\\\"network\\\":{\\\"client\\\":{\\\"ip\\\":\\\"%h\\\",\\\"name\\\":\\\"%{client.as.name}V\\\",\\\"number\\\":\\\"%{client.as.number}V\\\",\\\"connection_speed\\\":\\\"%{client.geo.conn_speed}V\\\"},\\\"destination\\\":{\\\"ip\\\":\\\"%A\\\"},\\\"geoip\\\":{\\\"geo_city\\\":\\\"%{client.geo.city.utf8}V\\\",\\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\\"geo_continent_code\\\":\\\"%{client.geo.continent_code}V\\\",\\\"geo_region\\\":\\\"%{client.geo.region}V\\\"},\\\"bytes_written\\\":\\\"%B\\\",\\\"bytes_read\\\":\\\"%{req.body_bytes_read}V\\\"},\\\"host\\\":\\\"%{Fastly-Orig-Host}i\\\",\\\"origin_host\\\":\\\"%v\\\",\\\"is_ipv6\\\":\\\"%{if(req.is_ipv6, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"is_tls\\\":\\\"%{if(req.is_ssl, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"tls_client_protocol\\\":\\\"%{json.escape(tls.client.protocol)}V\\\",\\\"tls_client_servername\\\":\\\"%{json.escape(tls.client.servername)}V\\\",\\\"tls_client_cipher\\\":\\\"%{json.escape(tls.client.cipher)}V\\\",\\\"tls_client_cipher_sha\\\":\\\"%{json.escape(tls.client.ciphers_sha)}V\\\",\\\"tls_client_tlsexts_sha\\\":\\\"%{json.escape(tls.client.tlsexts_sha)}V\\\",\\\"is_h2\\\":\\\"%{if(fastly_info.is_h2, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"is_h2_push\\\":\\\"%{if(fastly_info.h2.is_push, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"h2_stream_id\\\":\\\"%{fastly_info.h2.stream_id}V\\\",\\\"request_accept_content\\\":\\\"%{Accept}i\\\",\\\"request_accept_language\\\":\\\"%{Accept-Language}i\\\",\\\"request_accept_encoding\\\":\\\"%{Accept-Encoding}i\\\",\\\"request_accept_charset\\\":\\\"%{Accept-Charset}i\\\",\\\"request_connection\\\":\\\"%{Connection}i\\\",\\\"request_dnt\\\":\\\"%{DNT}i\\\",\\\"request_forwarded\\\":\\\"%{Forwarded}i\\\",\\\"request_via\\\":\\\"%{Via}i\\\",\\\"request_cache_control\\\":\\\"%{Cache-Control}i\\\",\\\"request_x_requested_with\\\":\\\"%{X-Requested-With}i\\\",\\\"request_x_att_device_id\\\":\\\"%{X-ATT-Device-Id}i\\\",\\\"content_type\\\":\\\"%{Content-Type}o\\\",\\\"is_cacheable\\\":\\\"%{if(fastly_info.state~\\\\\\\"^(HIT|MISS)$\\\\\\\", \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"response_age\\\":\\\"%{Age}o\\\",\\\"response_cache_control\\\":\\\"%{Cache-Control}o\\\",\\\"response_expires\\\":\\\"%{Expires}o\\\",\\\"response_last_modified\\\":\\\"%{Last-Modified}o\\\",\\\"response_tsv\\\":\\\"%{TSV}o\\\",\\\"server_datacenter\\\":\\\"%{server.datacenter}V\\\",\\\"req_header_size\\\":\\\"%{req.header_bytes_read}V\\\",\\\"resp_header_size\\\":\\\"%{resp.header_bytes_written}V\\\",\\\"socket_cwnd\\\":\\\"%{client.socket.cwnd}V\\\",\\\"socket_nexthop\\\":\\\"%{client.socket.nexthop}V\\\",\\\"socket_tcpi_rcv_mss\\\":\\\"%{client.socket.tcpi_rcv_mss}V\\\",\\\"socket_tcpi_snd_mss\\\":\\\"%{client.socket.tcpi_snd_mss}V\\\",\\\"socket_tcpi_rtt\\\":\\\"%{client.socket.tcpi_rtt}V\\\",\\\"socket_tcpi_rttvar\\\":\\\"%{client.socket.tcpi_rttvar}V\\\",\\\"socket_tcpi_rcv_rtt\\\":\\\"%{client.socket.tcpi_rcv_rtt}V\\\",\\\"socket_tcpi_rcv_space\\\":\\\"%{client.socket.tcpi_rcv_space}V\\\",\\\"socket_tcpi_last_data_sent\\\":\\\"%{client.socket.tcpi_last_data_sent}V\\\",\\\"socket_tcpi_total_retrans\\\":\\\"%{client.socket.tcpi_total_retrans}V\\\",\\\"socket_tcpi_delta_retrans\\\":\\\"%{client.socket.tcpi_delta_retrans}V\\\",\\\"socket_ploss\\\":\\\"%{client.socket.ploss}V\\\"}\",\"format_version\":2,\"created_at\":\"2020-04-22T16:50:01.000Z\",\"updated_at\":\"2020-04-22T16:50:01.000Z\",\"deleted_at\":null,\"response_condition\":\"\",\"placement\":null,\"token\":\"DD-API-KEY\"}","originalRequest":{"name":"Create a Datadog log endpoint","description":"Create a Datadog logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/datadog","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","datadog"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a Datadog log endpoint","request":{"name":"Get a Datadog log endpoint","description":"Get the details for a Datadog logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/datadog/{{logging_datadog_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","datadog","{{logging_datadog_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"region\":\"US\",\"format\":\"{\\\"ddsource\\\":\\\"fastly\\\",\\\"service\\\":\\\"%{req.service_id}V\\\",\\\"date\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"time_start\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"time_end\\\":\\\"%{end:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"http\\\":{\\\"request_time_ms\\\":\\\"%D\\\",\\\"method\\\":\\\"%m\\\",\\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\\"useragent\\\":\\\"%{User-Agent}i\\\",\\\"referer\\\":\\\"%{Referer}i\\\",\\\"protocol\\\":\\\"%H\\\",\\\"request_x_forwarded_for\\\":\\\"%{X-Forwarded-For}i\\\",\\\"status_code\\\":\\\"%s\\\"},\\\"network\\\":{\\\"client\\\":{\\\"ip\\\":\\\"%h\\\",\\\"name\\\":\\\"%{client.as.name}V\\\",\\\"number\\\":\\\"%{client.as.number}V\\\",\\\"connection_speed\\\":\\\"%{client.geo.conn_speed}V\\\"},\\\"destination\\\":{\\\"ip\\\":\\\"%A\\\"},\\\"geoip\\\":{\\\"geo_city\\\":\\\"%{client.geo.city.utf8}V\\\",\\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\\"geo_continent_code\\\":\\\"%{client.geo.continent_code}V\\\",\\\"geo_region\\\":\\\"%{client.geo.region}V\\\"},\\\"bytes_written\\\":\\\"%B\\\",\\\"bytes_read\\\":\\\"%{req.body_bytes_read}V\\\"},\\\"host\\\":\\\"%{Fastly-Orig-Host}i\\\",\\\"origin_host\\\":\\\"%v\\\",\\\"is_ipv6\\\":\\\"%{if(req.is_ipv6, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"is_tls\\\":\\\"%{if(req.is_ssl, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"tls_client_protocol\\\":\\\"%{json.escape(tls.client.protocol)}V\\\",\\\"tls_client_servername\\\":\\\"%{json.escape(tls.client.servername)}V\\\",\\\"tls_client_cipher\\\":\\\"%{json.escape(tls.client.cipher)}V\\\",\\\"tls_client_cipher_sha\\\":\\\"%{json.escape(tls.client.ciphers_sha)}V\\\",\\\"tls_client_tlsexts_sha\\\":\\\"%{json.escape(tls.client.tlsexts_sha)}V\\\",\\\"is_h2\\\":\\\"%{if(fastly_info.is_h2, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"is_h2_push\\\":\\\"%{if(fastly_info.h2.is_push, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"h2_stream_id\\\":\\\"%{fastly_info.h2.stream_id}V\\\",\\\"request_accept_content\\\":\\\"%{Accept}i\\\",\\\"request_accept_language\\\":\\\"%{Accept-Language}i\\\",\\\"request_accept_encoding\\\":\\\"%{Accept-Encoding}i\\\",\\\"request_accept_charset\\\":\\\"%{Accept-Charset}i\\\",\\\"request_connection\\\":\\\"%{Connection}i\\\",\\\"request_dnt\\\":\\\"%{DNT}i\\\",\\\"request_forwarded\\\":\\\"%{Forwarded}i\\\",\\\"request_via\\\":\\\"%{Via}i\\\",\\\"request_cache_control\\\":\\\"%{Cache-Control}i\\\",\\\"request_x_requested_with\\\":\\\"%{X-Requested-With}i\\\",\\\"request_x_att_device_id\\\":\\\"%{X-ATT-Device-Id}i\\\",\\\"content_type\\\":\\\"%{Content-Type}o\\\",\\\"is_cacheable\\\":\\\"%{if(fastly_info.state~\\\\\\\"^(HIT|MISS)$\\\\\\\", \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"response_age\\\":\\\"%{Age}o\\\",\\\"response_cache_control\\\":\\\"%{Cache-Control}o\\\",\\\"response_expires\\\":\\\"%{Expires}o\\\",\\\"response_last_modified\\\":\\\"%{Last-Modified}o\\\",\\\"response_tsv\\\":\\\"%{TSV}o\\\",\\\"server_datacenter\\\":\\\"%{server.datacenter}V\\\",\\\"req_header_size\\\":\\\"%{req.header_bytes_read}V\\\",\\\"resp_header_size\\\":\\\"%{resp.header_bytes_written}V\\\",\\\"socket_cwnd\\\":\\\"%{client.socket.cwnd}V\\\",\\\"socket_nexthop\\\":\\\"%{client.socket.nexthop}V\\\",\\\"socket_tcpi_rcv_mss\\\":\\\"%{client.socket.tcpi_rcv_mss}V\\\",\\\"socket_tcpi_snd_mss\\\":\\\"%{client.socket.tcpi_snd_mss}V\\\",\\\"socket_tcpi_rtt\\\":\\\"%{client.socket.tcpi_rtt}V\\\",\\\"socket_tcpi_rttvar\\\":\\\"%{client.socket.tcpi_rttvar}V\\\",\\\"socket_tcpi_rcv_rtt\\\":\\\"%{client.socket.tcpi_rcv_rtt}V\\\",\\\"socket_tcpi_rcv_space\\\":\\\"%{client.socket.tcpi_rcv_space}V\\\",\\\"socket_tcpi_last_data_sent\\\":\\\"%{client.socket.tcpi_last_data_sent}V\\\",\\\"socket_tcpi_total_retrans\\\":\\\"%{client.socket.tcpi_total_retrans}V\\\",\\\"socket_tcpi_delta_retrans\\\":\\\"%{client.socket.tcpi_delta_retrans}V\\\",\\\"socket_ploss\\\":\\\"%{client.socket.ploss}V\\\"}\",\"format_version\":2,\"created_at\":\"2020-04-22T16:50:01.000Z\",\"updated_at\":\"2020-04-22T16:50:01.000Z\",\"deleted_at\":null,\"response_condition\":\"\",\"placement\":null,\"token\":\"DD-API-KEY\"}","originalRequest":{"name":"Get a Datadog log endpoint","description":"Get the details for a Datadog logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/datadog/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","datadog","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a Datadog log endpoint","request":{"name":"Update a Datadog log endpoint","description":"Update the Datadog logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/datadog/{{logging_datadog_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","datadog","{{logging_datadog_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"name\":\"updated-test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"region\":\"US\",\"format\":\"{\\\"ddsource\\\":\\\"fastly\\\",\\\"service\\\":\\\"%{req.service_id}V\\\",\\\"date\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"time_start\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"time_end\\\":\\\"%{end:%Y-%m-%dT%H:%M:%S%Z}t\\\",\\\"http\\\":{\\\"request_time_ms\\\":\\\"%D\\\",\\\"method\\\":\\\"%m\\\",\\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\\"useragent\\\":\\\"%{User-Agent}i\\\",\\\"referer\\\":\\\"%{Referer}i\\\",\\\"protocol\\\":\\\"%H\\\",\\\"request_x_forwarded_for\\\":\\\"%{X-Forwarded-For}i\\\",\\\"status_code\\\":\\\"%s\\\"},\\\"network\\\":{\\\"client\\\":{\\\"ip\\\":\\\"%h\\\",\\\"name\\\":\\\"%{client.as.name}V\\\",\\\"number\\\":\\\"%{client.as.number}V\\\",\\\"connection_speed\\\":\\\"%{client.geo.conn_speed}V\\\"},\\\"destination\\\":{\\\"ip\\\":\\\"%A\\\"},\\\"geoip\\\":{\\\"geo_city\\\":\\\"%{client.geo.city.utf8}V\\\",\\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\\"geo_continent_code\\\":\\\"%{client.geo.continent_code}V\\\",\\\"geo_region\\\":\\\"%{client.geo.region}V\\\"},\\\"bytes_written\\\":\\\"%B\\\",\\\"bytes_read\\\":\\\"%{req.body_bytes_read}V\\\"},\\\"host\\\":\\\"%{Fastly-Orig-Host}i\\\",\\\"origin_host\\\":\\\"%v\\\",\\\"is_ipv6\\\":\\\"%{if(req.is_ipv6, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"is_tls\\\":\\\"%{if(req.is_ssl, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"tls_client_protocol\\\":\\\"%{json.escape(tls.client.protocol)}V\\\",\\\"tls_client_servername\\\":\\\"%{json.escape(tls.client.servername)}V\\\",\\\"tls_client_cipher\\\":\\\"%{json.escape(tls.client.cipher)}V\\\",\\\"tls_client_cipher_sha\\\":\\\"%{json.escape(tls.client.ciphers_sha)}V\\\",\\\"tls_client_tlsexts_sha\\\":\\\"%{json.escape(tls.client.tlsexts_sha)}V\\\",\\\"is_h2\\\":\\\"%{if(fastly_info.is_h2, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"is_h2_push\\\":\\\"%{if(fastly_info.h2.is_push, \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"h2_stream_id\\\":\\\"%{fastly_info.h2.stream_id}V\\\",\\\"request_accept_content\\\":\\\"%{Accept}i\\\",\\\"request_accept_language\\\":\\\"%{Accept-Language}i\\\",\\\"request_accept_encoding\\\":\\\"%{Accept-Encoding}i\\\",\\\"request_accept_charset\\\":\\\"%{Accept-Charset}i\\\",\\\"request_connection\\\":\\\"%{Connection}i\\\",\\\"request_dnt\\\":\\\"%{DNT}i\\\",\\\"request_forwarded\\\":\\\"%{Forwarded}i\\\",\\\"request_via\\\":\\\"%{Via}i\\\",\\\"request_cache_control\\\":\\\"%{Cache-Control}i\\\",\\\"request_x_requested_with\\\":\\\"%{X-Requested-With}i\\\",\\\"request_x_att_device_id\\\":\\\"%{X-ATT-Device-Id}i\\\",\\\"content_type\\\":\\\"%{Content-Type}o\\\",\\\"is_cacheable\\\":\\\"%{if(fastly_info.state~\\\\\\\"^(HIT|MISS)$\\\\\\\", \\\\\\\"true\\\\\\\", \\\\\\\"false\\\\\\\")}V\\\",\\\"response_age\\\":\\\"%{Age}o\\\",\\\"response_cache_control\\\":\\\"%{Cache-Control}o\\\",\\\"response_expires\\\":\\\"%{Expires}o\\\",\\\"response_last_modified\\\":\\\"%{Last-Modified}o\\\",\\\"response_tsv\\\":\\\"%{TSV}o\\\",\\\"server_datacenter\\\":\\\"%{server.datacenter}V\\\",\\\"req_header_size\\\":\\\"%{req.header_bytes_read}V\\\",\\\"resp_header_size\\\":\\\"%{resp.header_bytes_written}V\\\",\\\"socket_cwnd\\\":\\\"%{client.socket.cwnd}V\\\",\\\"socket_nexthop\\\":\\\"%{client.socket.nexthop}V\\\",\\\"socket_tcpi_rcv_mss\\\":\\\"%{client.socket.tcpi_rcv_mss}V\\\",\\\"socket_tcpi_snd_mss\\\":\\\"%{client.socket.tcpi_snd_mss}V\\\",\\\"socket_tcpi_rtt\\\":\\\"%{client.socket.tcpi_rtt}V\\\",\\\"socket_tcpi_rttvar\\\":\\\"%{client.socket.tcpi_rttvar}V\\\",\\\"socket_tcpi_rcv_rtt\\\":\\\"%{client.socket.tcpi_rcv_rtt}V\\\",\\\"socket_tcpi_rcv_space\\\":\\\"%{client.socket.tcpi_rcv_space}V\\\",\\\"socket_tcpi_last_data_sent\\\":\\\"%{client.socket.tcpi_last_data_sent}V\\\",\\\"socket_tcpi_total_retrans\\\":\\\"%{client.socket.tcpi_total_retrans}V\\\",\\\"socket_tcpi_delta_retrans\\\":\\\"%{client.socket.tcpi_delta_retrans}V\\\",\\\"socket_ploss\\\":\\\"%{client.socket.ploss}V\\\"}\",\"format_version\":2,\"created_at\":\"2020-04-22T16:50:01.000Z\",\"updated_at\":\"2020-04-22T16:50:01.000Z\",\"deleted_at\":null,\"response_condition\":\"\",\"placement\":null,\"token\":\"DD-API-KEY\"}","originalRequest":{"name":"Update a Datadog log endpoint","description":"Update the Datadog logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/datadog/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","datadog","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a Datadog log endpoint","request":{"name":"Delete a Datadog log endpoint","description":"Delete the Datadog logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/datadog/{{logging_datadog_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","datadog","{{logging_datadog_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a Datadog log endpoint","description":"Delete the Datadog logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/datadog/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","datadog","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"DigitalOcean Spaces","description":"Fastly will upload log messages to the DigitalOcean Space in the format specified in the DigitalOcean Spaces object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| access_key | string | Your DigitalOcean Spaces account access key. |\n| bucket_name | string | The name of the DigitalOcean Space. |\n| compression_codec | string | The codec used for compressing your logs. Valid values are zstd, snappy, and gzip. Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| domain | string | The domain of the DigitalOcean Spaces endpoint. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| gzip_level | integer | The level of gzip encoding when sending logs (default 0, no compression). Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| message_type | string | How the message should be formatted. |\n|  | classic | RFC 3164 syslog prefix. |\n|  | loggly | RFC 5424 structured syslog. |\n|  | logplex | Heroku-style length prefixed syslog. |\n|  | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| path | string | The path to upload logs to. |\n| period | integer | How frequently log files are finalized so they can be available for reading (in seconds). |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| secret_key | string | Your DigitalOcean Spaces account secret key. |\n| timestamp_format | string | A timestamp format. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List DigitalOcean Spaces log endpoints","request":{"name":"List DigitalOcean Spaces log endpoints","description":"List all of the DigitalOcean Spaces for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/digitalocean","path":["service","{{service_id}}","version","{{version_id}}","logging","digitalocean"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"deleted_at\":null,\"domain\":\"nyc3.digitaloceanspaces.com\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":null,\"period\":3600,\"placement\":null,\"response_condition\":\"\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":1}]","originalRequest":{"name":"List DigitalOcean Spaces log endpoints","description":"List all of the DigitalOcean Spaces for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/digitalocean","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","digitalocean"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a DigitalOcean Spaces log endpoint","request":{"name":"Create a DigitalOcean Spaces log endpoint","description":"Create a DigitalOcean Space for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/digitalocean","path":["service","{{service_id}}","version","{{version_id}}","logging","digitalocean"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"deleted_at\":null,\"domain\":\"nyc3.digitaloceanspaces.com\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":null,\"period\":3600,\"placement\":null,\"response_condition\":\"\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":1}","originalRequest":{"name":"Create a DigitalOcean Spaces log endpoint","description":"Create a DigitalOcean Space for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/digitalocean","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","digitalocean"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a DigitalOcean Spaces log endpoint","request":{"name":"Get a DigitalOcean Spaces log endpoint","description":"Get the DigitalOcean Space for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/digitalocean/{{logging_digitalocean_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","digitalocean","{{logging_digitalocean_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"deleted_at\":null,\"domain\":\"nyc3.digitaloceanspaces.com\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":null,\"period\":3600,\"placement\":null,\"response_condition\":\"\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":1}","originalRequest":{"name":"Get a DigitalOcean Spaces log endpoint","description":"Get the DigitalOcean Space for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/digitalocean/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","digitalocean","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a DigitalOcean Spaces log endpoint","request":{"name":"Update a DigitalOcean Spaces log endpoint","description":"Update the DigitalOcean Space for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/digitalocean/{{logging_digitalocean_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","digitalocean","{{logging_digitalocean_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"deleted_at\":null,\"domain\":\"nyc3.digitaloceanspaces.com\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"message_type\":\"classic\",\"name\":\"updated-test-log-endpoint\",\"path\":null,\"period\":3600,\"placement\":null,\"response_condition\":\"\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":1}","originalRequest":{"name":"Update a DigitalOcean Spaces log endpoint","description":"Update the DigitalOcean Space for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/digitalocean/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","digitalocean","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a DigitalOcean Spaces log endpoint","request":{"name":"Delete a DigitalOcean Spaces log endpoint","description":"Delete the DigitalOcean Space for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/digitalocean/{{logging_digitalocean_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","digitalocean","{{logging_digitalocean_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a DigitalOcean Spaces log endpoint","description":"Delete the DigitalOcean Space for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/digitalocean/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","digitalocean","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Elasticsearch","description":"Fastly will upload log messages periodically to the server in the format specified in the Elasticsearch object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| format | string | A Fastly log format string. Must produce valid JSON that Elasticsearch can ingest. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| index | string | The name of the Elasticsearch index to send documents (logs) to. The index must follow the Elasticsearch index format rules. We support strftime interpolated variables inside braces prefixed with a pound symbol. For example, #{%F} will interpolate as YYYY-MM-DD with today's date. |\n| name | string | The name for the real-time logging configuration. |\n| password | string | Basic Auth password. |\n| pipeline | string | The ID of the Elasticsearch ingest pipeline to apply pre-process transformations to before indexing. Learn more about creating a pipeline in the Elasticsearch docs. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| request_max_bytes | integer | The maximum number of bytes sent in one request. Defaults 0 for unbounded. |\n| request_max_entries | integer | The maximum number of logs sent in one request. Defaults 0 for unbounded. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| tls_ca_cert | string | A secure certificate to authenticate a server with. Must be in PEM format. |\n| tls_client_cert | string | The client certificate used to make authenticated requests. Must be in PEM format. |\n| tls_client_key | string | The client private key used to make authenticated requests. Must be in PEM format. |\n| tls_hostname | string | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. |\n| url | string | The URL to stream logs to. Must use HTTPS. |\n| user | string | Basic Auth username. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List Elasticsearch log endpoints","request":{"name":"List Elasticsearch log endpoints","description":"List all of the Elasticsearch logging endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/elasticsearch","path":["service","{{service_id}}","version","{{version_id}}","logging","elasticsearch"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"format_version\":2,\"tls_hostname\":null,\"response_condition\":\"\",\"index\":\"test-index\",\"request_max_entries\":0,\"deleted_at\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"password\":null,\"version\":1,\"name\":\"test-log-endpoint\",\"user\":null,\"updated_at\":\"2020-07-02T23:13:17.000Z\",\"tls_client_key\":null,\"created_at\":\"2020-07-02T23:13:17.000Z\",\"request_max_bytes\":0,\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"url\":\"https://www.example.com\",\"pipeline\":null,\"tls_client_cert\":null,\"tls_ca_cert\":null,\"placement\":null}]","originalRequest":{"name":"List Elasticsearch log endpoints","description":"List all of the Elasticsearch logging endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/elasticsearch","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","elasticsearch"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create an Elasticsearch log endpoint","request":{"name":"Create an Elasticsearch log endpoint","description":"Create a Elasticsearch logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/elasticsearch","path":["service","{{service_id}}","version","{{version_id}}","logging","elasticsearch"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"format_version\":2,\"tls_hostname\":null,\"response_condition\":\"\",\"index\":\"test-index\",\"request_max_entries\":0,\"deleted_at\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"password\":null,\"version\":1,\"name\":\"test-log-endpoint\",\"user\":null,\"updated_at\":\"2020-07-02T23:13:17.000Z\",\"tls_client_key\":null,\"created_at\":\"2020-07-02T23:13:17.000Z\",\"request_max_bytes\":0,\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"url\":\"https://www.example.com\",\"pipeline\":null,\"tls_client_cert\":null,\"tls_ca_cert\":null,\"placement\":null}","originalRequest":{"name":"Create an Elasticsearch log endpoint","description":"Create a Elasticsearch logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/elasticsearch","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","elasticsearch"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get an Elasticsearch log endpoint","request":{"name":"Get an Elasticsearch log endpoint","description":"Get the Elasticsearch logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/elasticsearch/{{logging_elasticsearch_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","elasticsearch","{{logging_elasticsearch_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"format_version\":2,\"tls_hostname\":null,\"response_condition\":\"\",\"index\":\"test-index\",\"request_max_entries\":0,\"deleted_at\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"password\":null,\"version\":1,\"name\":\"test-log-endpoint\",\"user\":null,\"updated_at\":\"2020-07-02T23:13:17.000Z\",\"tls_client_key\":null,\"created_at\":\"2020-07-02T23:13:17.000Z\",\"request_max_bytes\":0,\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"url\":\"https://www.example.com\",\"pipeline\":null,\"tls_client_cert\":null,\"tls_ca_cert\":null,\"placement\":null}","originalRequest":{"name":"Get an Elasticsearch log endpoint","description":"Get the Elasticsearch logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/elasticsearch/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","elasticsearch","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update an Elasticsearch log endpoint","request":{"name":"Update an Elasticsearch log endpoint","description":"Update the Elasticsearch logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/elasticsearch/{{logging_elasticsearch_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","elasticsearch","{{logging_elasticsearch_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"format_version\":2,\"tls_hostname\":null,\"response_condition\":\"\",\"index\":\"test-index\",\"request_max_entries\":0,\"deleted_at\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"password\":null,\"version\":1,\"name\":\"updated-test-log-endpoint\",\"user\":null,\"updated_at\":\"2020-07-02T23:13:17.000Z\",\"tls_client_key\":null,\"created_at\":\"2020-07-02T23:13:17.000Z\",\"request_max_bytes\":0,\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"url\":\"https://www.example.com\",\"pipeline\":null,\"tls_client_cert\":null,\"tls_ca_cert\":null,\"placement\":null}","originalRequest":{"name":"Update an Elasticsearch log endpoint","description":"Update the Elasticsearch logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/elasticsearch/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","elasticsearch","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete an Elasticsearch log endpoint","request":{"name":"Delete an Elasticsearch log endpoint","description":"Delete the Elasticsearch logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/elasticsearch/{{logging_elasticsearch_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","elasticsearch","{{logging_elasticsearch_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete an Elasticsearch log endpoint","description":"Delete the Elasticsearch logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/elasticsearch/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","elasticsearch","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"FTP","description":"Fastly will upload log messages periodically to the server in the format specified in the FTP object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| address | string | An hostname or IPv4 address. |\n| compression_codec | string | The codec used for compressing your logs. Valid values are zstd, snappy, and gzip. Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| gzip_level | integer | The level of gzip encoding when sending logs (default 0, no compression). Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| hostname | string | Hostname used. |\n| ipv4 | string | IPv4 address of the host. |\n| message_type | string | How the message should be formatted. |\n|  | classic | RFC 3164 syslog prefix. |\n|  | loggly | RFC 5424 structured syslog. |\n|  | logplex | Heroku-style length prefixed syslog. |\n|  | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| password | string | The password for the server. For anonymous use an email address. |\n| path | string | The path to upload log files to. If the path ends in / then it is treated as a directory. |\n| period | integer | How frequently log files are finalized so they can be available for reading (in seconds). |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| port | integer | The port number. |\n| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| timestamp_format | string | A timestamp format. |\n| user | string | The username for the server. Can be anonymous. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List FTP log endpoints","request":{"name":"List FTP log endpoints","description":"List all of the FTPs for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/ftp","path":["service","{{service_id}}","version","{{version_id}}","logging","ftp"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"address\":\"example.com\",\"created_at\":\"2020-05-17T18:27:29.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"hostname\":\"example.com\",\"ipv4\":\"127.0.0.1\",\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"password\":\"ftp@example.com\",\"path\":\"/\",\"period\":3600,\"placement\":null,\"port\":21,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-17T18:27:29.000Z\",\"user\":\"anonymous\",\"version\":1}]","originalRequest":{"name":"List FTP log endpoints","description":"List all of the FTPs for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/ftp","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","ftp"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create an FTP log endpoint","request":{"name":"Create an FTP log endpoint","description":"Create a FTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/ftp","path":["service","{{service_id}}","version","{{version_id}}","logging","ftp"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"address\":\"example.com\",\"created_at\":\"2020-05-17T18:27:29.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"hostname\":\"example.com\",\"ipv4\":\"127.0.0.1\",\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"password\":\"ftp@example.com\",\"path\":\"/\",\"period\":3600,\"placement\":null,\"port\":21,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-17T18:27:29.000Z\",\"user\":\"anonymous\",\"version\":1}","originalRequest":{"name":"Create an FTP log endpoint","description":"Create a FTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/ftp","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","ftp"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get an FTP log endpoint","request":{"name":"Get an FTP log endpoint","description":"Get the FTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/ftp/{{logging_ftp_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","ftp","{{logging_ftp_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"address\":\"example.com\",\"created_at\":\"2020-05-17T18:27:29.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"hostname\":\"example.com\",\"ipv4\":\"127.0.0.1\",\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"password\":\"ftp@example.com\",\"path\":\"/\",\"period\":3600,\"placement\":null,\"port\":21,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-17T18:27:29.000Z\",\"user\":\"anonymous\",\"version\":1}","originalRequest":{"name":"Get an FTP log endpoint","description":"Get the FTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/ftp/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","ftp","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update an FTP log endpoint","request":{"name":"Update an FTP log endpoint","description":"Update the FTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/ftp/{{logging_ftp_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","ftp","{{logging_ftp_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"address\":\"example.com\",\"created_at\":\"2020-05-17T18:27:29.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"hostname\":\"example.com\",\"ipv4\":\"127.0.0.1\",\"message_type\":\"classic\",\"name\":\"updated-test-log-endpoint\",\"password\":\"ftp@example.com\",\"path\":\"/\",\"period\":3600,\"placement\":null,\"port\":21,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-17T18:27:29.000Z\",\"user\":\"anonymous\",\"version\":1}","originalRequest":{"name":"Update an FTP log endpoint","description":"Update the FTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/ftp/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","ftp","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete an FTP log endpoint","request":{"name":"Delete an FTP log endpoint","description":"Delete the FTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/ftp/{{logging_ftp_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","ftp","{{logging_ftp_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete an FTP log endpoint","description":"Delete the FTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/ftp/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","ftp","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"GCS Logging","description":"Fastly will upload log messages to the GCS bucket in the format specified in the GCS object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| bucket_name | string | The name of the GCS bucket. |\n| compression_codec | string | The codec used for compressing your logs. Valid values are zstd, snappy, and gzip. Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| gzip_level | integer | The level of gzip encoding when sending logs (default 0, no compression). Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| message_type | string | How the message should be formatted. |\n|  | classic | RFC 3164 syslog prefix. |\n|  | loggly | RFC 5424 structured syslog. |\n|  | logplex | Heroku-style length prefixed syslog. |\n|  | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| path | string | The path to upload logs to. |\n| period | integer | How frequently log files are finalized so they can be available for reading (in seconds). |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| secret_key | string | Your Google Cloud Platform account secret key. The private_key field in your service account authentication JSON. Required. |\n| timestamp_format | string | A timestamp format. |\n| user | string | Your Google Cloud Platform service account email address. The client_email field in your service account authentication JSON. Required. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List GCS log endpoints","request":{"name":"List GCS log endpoints","description":"List all of the GCS log endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/gcs","path":["service","{{service_id}}","version","{{version_id}}","logging","gcs"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"topic\":\"test-topic\",\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}]","originalRequest":{"name":"List GCS log endpoints","description":"List all of the GCS log endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/gcs","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","gcs"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a GCS log endpoint","request":{"name":"Create a GCS log endpoint","description":"Create GCS logging for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/gcs","path":["service","{{service_id}}","version","{{version_id}}","logging","gcs"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"topic\":\"test-topic\",\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}","originalRequest":{"name":"Create a GCS log endpoint","description":"Create GCS logging for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/gcs","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","gcs"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a GCS log endpoint","request":{"name":"Get a GCS log endpoint","description":"Get the GCS Logging for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/gcs/{{logging_gcs_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","gcs","{{logging_gcs_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"topic\":\"test-topic\",\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}","originalRequest":{"name":"Get a GCS log endpoint","description":"Get the GCS Logging for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/gcs/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","gcs","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a GCS log endpoint","request":{"name":"Update a GCS log endpoint","description":"Update the GCS for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/gcs/{{logging_gcs_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","gcs","{{logging_gcs_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"name\":\"updated-test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"topic\":\"test-topic\",\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}","originalRequest":{"name":"Update a GCS log endpoint","description":"Update the GCS for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/gcs/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","gcs","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a GCS log endpoint","request":{"name":"Delete a GCS log endpoint","description":"Delete the GCS Logging for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/gcs/{{logging_gcs_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","gcs","{{logging_gcs_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a GCS log endpoint","description":"Delete the GCS Logging for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/gcs/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","gcs","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Google Cloud Pub/Sub Logging","description":"Fastly will publish log messages to a Google Cloud Pub/Sub topic in the format specified in the Pub/Sub logging object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| project_id | string | Your Google Cloud Platform project ID. Required. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| secret_key | string | Your Google Cloud Platform account secret key. The private_key field in your service account authentication JSON. Required. |\n| topic | string | The Google Cloud Pub/Sub topic to which logs will be published. Required. |\n| user | string | Your Google Cloud Platform service account email address. The client_email field in your service account authentication JSON. Required. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List GCP Cloud Pub/Sub log endpoints","request":{"name":"List GCP Cloud Pub/Sub log endpoints","description":"List all of the Pub/Sub logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/pubsub","path":["service","{{service_id}}","version","{{version_id}}","logging","pubsub"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":2,\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"project_id\":\"test-project-id\",\"topic\":\"test-topic\",\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}]","originalRequest":{"name":"List GCP Cloud Pub/Sub log endpoints","description":"List all of the Pub/Sub logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/pubsub","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","pubsub"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a GCP Cloud Pub/Sub log endpoint","request":{"name":"Create a GCP Cloud Pub/Sub log endpoint","description":"Create a Pub/Sub logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/pubsub","path":["service","{{service_id}}","version","{{version_id}}","logging","pubsub"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":2,\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"project_id\":\"test-project-id\",\"topic\":\"test-topic\",\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}","originalRequest":{"name":"Create a GCP Cloud Pub/Sub log endpoint","description":"Create a Pub/Sub logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/pubsub","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","pubsub"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a GCP Cloud Pub/Sub log endpoint","request":{"name":"Get a GCP Cloud Pub/Sub log endpoint","description":"Get the details for a Pub/Sub logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/pubsub/{{logging_google_pubsub_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","pubsub","{{logging_google_pubsub_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":2,\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"project_id\":\"test-project-id\",\"topic\":\"test-topic\",\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}","originalRequest":{"name":"Get a GCP Cloud Pub/Sub log endpoint","description":"Get the details for a Pub/Sub logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/pubsub/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","pubsub","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a GCP Cloud Pub/Sub log endpoint","request":{"name":"Update a GCP Cloud Pub/Sub log endpoint","description":"Update a Pub/Sub logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/pubsub/{{logging_google_pubsub_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","pubsub","{{logging_google_pubsub_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":2,\"user\":\"test-user@test-project-id.iam.gserviceaccount.com\",\"project_id\":\"test-project-id\",\"topic\":\"updated-test-topic\",\"secret_key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"response_condition\":\"\"}","originalRequest":{"name":"Update a GCP Cloud Pub/Sub log endpoint","description":"Update a Pub/Sub logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/pubsub/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","pubsub","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a GCP Cloud Pub/Sub log endpoint","request":{"name":"Delete a GCP Cloud Pub/Sub log endpoint","description":"Delete a Pub/Sub logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/pubsub/{{logging_google_pubsub_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","pubsub","{{logging_google_pubsub_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a GCP Cloud Pub/Sub log endpoint","description":"Delete a Pub/Sub logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/pubsub/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","pubsub","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Heroku","description":"Fastly will stream log messages to the Heroku account in the format specified in the Heroku object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| token | string | The token to use for authentication ( https://devcenter.heroku.com/articles/add-on-partner-log-integration). |\n| url | string | The URL to stream logs to. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List Heroku log endpoints","request":{"name":"List Heroku log endpoints","description":"List all of the Herokus for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/heroku","path":["service","{{service_id}}","version","{{version_id}}","logging","heroku"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"response_condition\":\"\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"placement\":null,\"token\":\"test-token\",\"url\":\"https://1.us.logplex.io/logs\"}]","originalRequest":{"name":"List Heroku log endpoints","description":"List all of the Herokus for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/heroku","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","heroku"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a Heroku log endpoint","request":{"name":"Create a Heroku log endpoint","description":"Create a Heroku for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/heroku","path":["service","{{service_id}}","version","{{version_id}}","logging","heroku"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"response_condition\":\"\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"placement\":null,\"token\":\"test-token\",\"url\":\"https://1.us.logplex.io/logs\"}","originalRequest":{"name":"Create a Heroku log endpoint","description":"Create a Heroku for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/heroku","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","heroku"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a Heroku log endpoint","request":{"name":"Get a Heroku log endpoint","description":"Get the Heroku for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/heroku/{{logging_heroku_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","heroku","{{logging_heroku_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"response_condition\":\"\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"placement\":null,\"token\":\"test-token\",\"url\":\"https://1.us.logplex.io/logs\"}","originalRequest":{"name":"Get a Heroku log endpoint","description":"Get the Heroku for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/heroku/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","heroku","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update the Heroku log endpoint","request":{"name":"Update the Heroku log endpoint","description":"Update the Heroku for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/heroku/{{logging_heroku_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","heroku","{{logging_heroku_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"name\":\"updated-test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"response_condition\":\"\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"placement\":null,\"token\":\"test-token\",\"url\":\"https://1.us.logplex.io/logs\"}","originalRequest":{"name":"Update the Heroku log endpoint","description":"Update the Heroku for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/heroku/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","heroku","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete the Heroku log endpoint","request":{"name":"Delete the Heroku log endpoint","description":"Delete the Heroku for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/heroku/{{logging_heroku_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","heroku","{{logging_heroku_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete the Heroku log endpoint","description":"Delete the Heroku for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/heroku/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","heroku","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Honeycomb Logging","description":"Fastly will upload log messages to Honeycomb.io in the format specified in the Honeycomb object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| dataset | string | The Honeycomb Dataset you want to log to. |\n| format | string | A Fastly log format string. Must produce valid JSON that Honeycomb can ingest. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| token | string | The Write Key from the Account page of your Honeycomb account. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List Honeycomb log endpoints","request":{"name":"List Honeycomb log endpoints","description":"List all of the Honeycomb logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/honeycomb","path":["service","{{service_id}}","version","{{version_id}}","logging","honeycomb"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":2,\"dataset\":\"fastly_honeycomb\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null}]","originalRequest":{"name":"List Honeycomb log endpoints","description":"List all of the Honeycomb logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/honeycomb","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","honeycomb"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a Honeycomb log endpoint","request":{"name":"Create a Honeycomb log endpoint","description":"Create a Honeycomb logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/honeycomb","path":["service","{{service_id}}","version","{{version_id}}","logging","honeycomb"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":2,\"dataset\":\"fastly_honeycomb\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null}","originalRequest":{"name":"Create a Honeycomb log endpoint","description":"Create a Honeycomb logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/honeycomb","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","honeycomb"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a Honeycomb log endpoint","request":{"name":"Get a Honeycomb log endpoint","description":"Get the details of a Honeycomb logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/honeycomb/{{logging_honeycomb_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","honeycomb","{{logging_honeycomb_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"name\":\"test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":2,\"dataset\":\"fastly_honeycomb\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null}","originalRequest":{"name":"Get a Honeycomb log endpoint","description":"Get the details of a Honeycomb logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/honeycomb/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","honeycomb","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a Honeycomb log endpoint","request":{"name":"Update a Honeycomb log endpoint","description":"Update a Honeycomb logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/honeycomb/{{logging_honeycomb_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","honeycomb","{{logging_honeycomb_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"name\":\"updated-test-log-endpoint\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\",\"format_version\":2,\"dataset\":\"fastly_honeycomb\",\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null}","originalRequest":{"name":"Update a Honeycomb log endpoint","description":"Update a Honeycomb logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/honeycomb/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","honeycomb","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete the Honeycomb log endpoint","request":{"name":"Delete the Honeycomb log endpoint","description":"Delete the Honeycomb logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/honeycomb/{{logging_honeycomb_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","honeycomb","{{logging_honeycomb_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete the Honeycomb log endpoint","description":"Delete the Honeycomb logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/honeycomb/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","honeycomb","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"HTTPS","description":"Fastly will upload log messages to an HTTPS endpoint in the format specified in the HTTPS object. The HTTPS endpoint requires proof of domain ownership before logs can be received. Learn how to validate your domain in our HTTPS endpoint documentation.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| content_type | string | Content type of the header sent with the request. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| header_name | string | Name of the custom header sent with the request. |\n| header_value | string | Value of the custom header sent with the request. |\n| json_format | string | Enforces valid JSON formatting for log entries. |\n|  | 0 | Disabled. |\n|  | 1 | Array of JSON. Wraps JSON log batches in an array. |\n|  | 2 | Newline delimited JSON. Places each JSON log entry onto a new line in a batch. |\n| message_type | string | How the message should be formatted. |\n|  | classic | RFC 3164 syslog prefix. |\n|  | loggly | RFC 5424 structured syslog. |\n|  | logplex | Heroku-style length prefixed syslog. |\n|  | blank | No prefix. Useful for writing JSON and CSV. |\n| method | string | HTTP method used for request. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| request_max_bytes | integer | The maximum number of bytes sent in one request. Defaults 0 (100MB). |\n| request_max_entries | integer | The maximum number of logs sent in one request. Defaults 0 (10k). |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| tls_ca_cert | string | A secure certificate to authenticate a server with. Must be in PEM format. |\n| tls_client_cert | string | The client certificate used to make authenticated requests. Must be in PEM format. |\n| tls_client_key | string | The client private key used to make authenticated requests. Must be in PEM format. |\n| tls_hostname | string | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. |\n| url | string | The URL to send logs to. Must use HTTPS. Required. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List HTTPS log endpoints","request":{"name":"List HTTPS log endpoints","description":"List all of the HTTPS objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/https","path":["service","{{service_id}}","version","{{version_id}}","logging","https"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"name\":\"test-log-endpoint\",\"url\":\"https://example.com/logging/endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"request_max_entries\":0,\"request_max_bytes\":0,\"header_name\":null,\"method\":\"POST\",\"updated_at\":\"2020-03-05T15:25:17.000Z\",\"content_type\":null,\"response_condition\":\"\",\"tls_client_key\":null,\"message_type\":\"blank\",\"deleted_at\":null,\"tls_client_cert\":null,\"header_value\":null,\"tls_hostname\":null,\"format_version\":2,\"json_format\":\"0\",\"tls_ca_cert\":null,\"placement\":null,\"created_at\":\"2020-03-05T15:25:17.000Z\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\"}]","originalRequest":{"name":"List HTTPS log endpoints","description":"List all of the HTTPS objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/https","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","https"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create an HTTPS log endpoint","request":{"name":"Create an HTTPS log endpoint","description":"Create an HTTPS object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/https","path":["service","{{service_id}}","version","{{version_id}}","logging","https"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"name\":\"test-log-endpoint\",\"url\":\"https://example.com/logging/endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"request_max_entries\":0,\"request_max_bytes\":0,\"header_name\":null,\"method\":\"POST\",\"updated_at\":\"2020-03-05T15:25:17.000Z\",\"content_type\":null,\"response_condition\":\"\",\"tls_client_key\":null,\"message_type\":\"blank\",\"deleted_at\":null,\"tls_client_cert\":null,\"header_value\":null,\"tls_hostname\":null,\"format_version\":2,\"json_format\":\"0\",\"tls_ca_cert\":null,\"placement\":null,\"created_at\":\"2020-03-05T15:25:17.000Z\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\"}","originalRequest":{"name":"Create an HTTPS log endpoint","description":"Create an HTTPS object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/https","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","https"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get an HTTPS log endpoint","request":{"name":"Get an HTTPS log endpoint","description":"Get the HTTPS object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/https/{{logging_https_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","https","{{logging_https_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"name\":\"test-log-endpoint\",\"url\":\"https://example.com/logging/endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"request_max_entries\":0,\"request_max_bytes\":0,\"header_name\":null,\"method\":\"POST\",\"updated_at\":\"2020-03-05T15:25:17.000Z\",\"content_type\":null,\"response_condition\":\"\",\"tls_client_key\":null,\"message_type\":\"blank\",\"deleted_at\":null,\"tls_client_cert\":null,\"header_value\":null,\"tls_hostname\":null,\"format_version\":2,\"json_format\":\"0\",\"tls_ca_cert\":null,\"placement\":null,\"created_at\":\"2020-03-05T15:25:17.000Z\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\"}","originalRequest":{"name":"Get an HTTPS log endpoint","description":"Get the HTTPS object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/https/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","https","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update an HTTPS log endpoint","request":{"name":"Update an HTTPS log endpoint","description":"Update the HTTPS object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/https/{{logging_https_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","https","{{logging_https_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"name\":\"updated-test-log-endpoint\",\"url\":\"https://example.com/logging/endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"request_max_entries\":0,\"request_max_bytes\":0,\"header_name\":null,\"method\":\"POST\",\"updated_at\":\"2020-03-05T15:25:17.000Z\",\"content_type\":null,\"response_condition\":\"\",\"tls_client_key\":null,\"message_type\":\"blank\",\"deleted_at\":null,\"tls_client_cert\":null,\"header_value\":null,\"tls_hostname\":null,\"format_version\":2,\"json_format\":\"0\",\"tls_ca_cert\":null,\"placement\":null,\"created_at\":\"2020-03-05T15:25:17.000Z\",\"format\":\"{ \\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\",\\n  \\\"time_elapsed\\\":%{time.elapsed.usec}V,\\n  \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V,\\n  \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\",\\n  \\\"geo_city\\\":\\\"%{client.geo.city}V\\\",\\n  \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\",\\n  \\\"request\\\":\\\"%{req.request}V\\\",\\n  \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\",\\n  \\\"url\\\":\\\"%{json.escape(req.url)}V\\\",\\n  \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\",\\n  \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\",\\n  \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\",\\n  \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\",\\n  \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"\\n}\"}","originalRequest":{"name":"Update an HTTPS log endpoint","description":"Update the HTTPS object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/https/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","https","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete an HTTPS log endpoint","request":{"name":"Delete an HTTPS log endpoint","description":"Delete the HTTPS object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/https/{{logging_https_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","https","{{logging_https_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete an HTTPS log endpoint","description":"Delete the HTTPS object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/https/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","https","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Kafka","description":"Fastly will upload log messages periodically to the server in the format specified in the Kafka object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| auth_method | string | SASL authentication method. |\n|  | plain | Use plain user and password authentication. |\n|  | scram-sha-256 | Use salted challenge response authentication mechanism with SHA-256 hash function. |\n|  | scram-sha-512 | Use salted challenge response authentication mechanism with SHA-512 hash function. |\n| brokers | string | A comma-separated list of IP addresses or hostnames of Kafka brokers. Required. |\n| compression_codec | string | The codec used for compression of your logs. |\n|  | gzip | Use gzip compression. |\n|  | snappy | Use Snappy compression. |\n|  | lz4 | Use LZ4 compression. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| parse_log_keyvals | boolean | Enables parsing of key=value tuples from the beginning of a logline, turning them into record headers. |\n| password | string | SASL password. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| request_max_bytes | integer | The maximum number of bytes sent in one request. Defaults 0 (no limit). |\n| required_acks | integer | The number of acknowledgements a leader must receive before a write is considered successful. |\n|  | 1 | One server needs to respond. |\n|  | 0 | No servers need to respond. |\n|  | -1 | Wait for all in-sync replicas to respond. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| tls_ca_cert | string | A secure certificate to authenticate a server with. Must be in PEM format. |\n| tls_client_cert | string | The client certificate used to make authenticated requests. Must be in PEM format. |\n| tls_client_key | string | The client private key used to make authenticated requests. Must be in PEM format. |\n| tls_hostname | string | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. |\n| topic | string | The Kafka topic to send logs to. Required. |\n| use_tls | integer | Whether to use TLS. |\n|  | 0 | Do not use TLS. |\n|  | 1 | Use TLS. |\n| user | string | SASL user. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List Kafka log endpoints","request":{"name":"List Kafka log endpoints","description":"List all of the Kafka logging endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kafka","path":["service","{{service_id}}","version","{{version_id}}","logging","kafka"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"format_version\":2,\"tls_client_key\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"tls_ca_cert\":null,\"response_condition\":\"\",\"tls_hostname\":null,\"compression_codec\":null,\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"topic\":\"test-topic\",\"created_at\":\"2020-04-25T20:17:00.000Z\",\"deleted_at\":null,\"brokers\":\"localhost:1234\",\"required_acks\":1,\"updated_at\":\"2020-04-25T20:17:00.000Z\",\"tls_client_cert\":null,\"use_tls\":0,\"placement\":null,\"version\":1}]","originalRequest":{"name":"List Kafka log endpoints","description":"List all of the Kafka logging endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kafka","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","kafka"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a Kafka log endpoint","request":{"name":"Create a Kafka log endpoint","description":"Create a Kafka logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kafka","path":["service","{{service_id}}","version","{{version_id}}","logging","kafka"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"format_version\":2,\"tls_client_key\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"tls_ca_cert\":null,\"response_condition\":\"\",\"tls_hostname\":null,\"compression_codec\":null,\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"topic\":\"test-topic\",\"created_at\":\"2020-04-25T20:17:00.000Z\",\"deleted_at\":null,\"brokers\":\"localhost:1234\",\"required_acks\":1,\"updated_at\":\"2020-04-25T20:17:00.000Z\",\"tls_client_cert\":null,\"use_tls\":0,\"placement\":null,\"version\":1}","originalRequest":{"name":"Create a Kafka log endpoint","description":"Create a Kafka logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kafka","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","kafka"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a Kafka log endpoint","request":{"name":"Get a Kafka log endpoint","description":"Get the Kafka logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kafka/{{logging_kafka_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","kafka","{{logging_kafka_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"format_version\":2,\"tls_client_key\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"tls_ca_cert\":null,\"response_condition\":\"\",\"tls_hostname\":null,\"compression_codec\":null,\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"topic\":\"test-topic\",\"created_at\":\"2020-04-25T20:17:00.000Z\",\"deleted_at\":null,\"brokers\":\"localhost:1234\",\"required_acks\":1,\"updated_at\":\"2020-04-25T20:17:00.000Z\",\"tls_client_cert\":null,\"use_tls\":0,\"placement\":null,\"version\":1}","originalRequest":{"name":"Get a Kafka log endpoint","description":"Get the Kafka logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kafka/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","kafka","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update the Kafka log endpoint","request":{"name":"Update the Kafka log endpoint","description":"Update the Kafka logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kafka/{{logging_kafka_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","kafka","{{logging_kafka_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"format_version\":2,\"tls_client_key\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"tls_ca_cert\":null,\"response_condition\":\"\",\"tls_hostname\":null,\"compression_codec\":null,\"name\":\"updated-test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"topic\":\"test-topic\",\"created_at\":\"2020-04-25T20:17:00.000Z\",\"deleted_at\":null,\"brokers\":\"localhost:1234\",\"required_acks\":1,\"updated_at\":\"2020-04-25T20:17:00.000Z\",\"tls_client_cert\":null,\"use_tls\":0,\"placement\":null,\"version\":1}","originalRequest":{"name":"Update the Kafka log endpoint","description":"Update the Kafka logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kafka/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","kafka","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete the Kafka log endpoint","request":{"name":"Delete the Kafka log endpoint","description":"Delete the Kafka logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kafka/{{logging_kafka_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","kafka","{{logging_kafka_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete the Kafka log endpoint","description":"Delete the Kafka logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kafka/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","kafka","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Kinesis","description":"Fastly will publish log messages to an Amazon Kinesis stream in the format specified in the Amazon Kinesis Data Streams logging object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| access_key | string | The access key associated with the target Amazon Kinesis stream. Not required if iam_role is specified. |\n| format | string | A Fastly log format string. Must produce valid JSON that Kinesis can ingest. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| iam_role | string | The ARN for an IAM role granting Fastly access to the target Amazon Kinesis stream. Not required if access_key and secret_key are provided. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| region | string | A named set of AWS resources that's in the same geographical area. |\n| secret_key | string | The secret key associated with the target Amazon Kinesis stream. Not required if iam_role is specified. |\n| topic | string | The Amazon Kinesis stream to send logs to. Required. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List Amazon Kinesis log endpoints","request":{"name":"List Amazon Kinesis log endpoints","description":"List all of the Amazon Kinesis Data Streams logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kinesis","path":["service","{{service_id}}","version","{{version_id}}","logging","kinesis"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"format\":\"{\\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\", \\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"}\",\"format_version\":2,\"iam_role\":null,\"name\":\"test-log-endpoint\",\"placement\":null,\"region\":\"us-east-1\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"topic\":\"my-kinesis-stream\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":1}]","originalRequest":{"name":"List Amazon Kinesis log endpoints","description":"List all of the Amazon Kinesis Data Streams logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kinesis","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","kinesis"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create  an Amazon Kinesis log endpoint","request":{"name":"Create  an Amazon Kinesis log endpoint","description":"Create an Amazon Kinesis Data Streams logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kinesis","path":["service","{{service_id}}","version","{{version_id}}","logging","kinesis"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"format\":\"{\\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\", \\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"}\",\"format_version\":2,\"iam_role\":null,\"name\":\"test-log-endpoint\",\"placement\":null,\"region\":\"us-east-1\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"topic\":\"my-kinesis-stream\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":1}","originalRequest":{"name":"Create  an Amazon Kinesis log endpoint","description":"Create an Amazon Kinesis Data Streams logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kinesis","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","kinesis"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get an Amazon Kinesis log endpoint","request":{"name":"Get an Amazon Kinesis log endpoint","description":"Get the details for an Amazon Kinesis Data Streams logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kinesis/{{logging_kinesis_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","kinesis","{{logging_kinesis_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"format\":\"{\\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\", \\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"}\",\"format_version\":2,\"iam_role\":null,\"name\":\"test-log-endpoint\",\"placement\":null,\"region\":\"us-east-1\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"topic\":\"my-kinesis-stream\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":1}","originalRequest":{"name":"Get an Amazon Kinesis log endpoint","description":"Get the details for an Amazon Kinesis Data Streams logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kinesis/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","kinesis","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update the Amazon Kinesis log endpoint","request":{"name":"Update the Amazon Kinesis log endpoint","description":"Update an Amazon Kinesis Data Streams logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kinesis/{{logging_kinesis_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","kinesis","{{logging_kinesis_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"format\":\"{\\\"timestamp\\\":\\\"%{begin:%Y-%m-%dT%H:%M:%S}t\\\", \\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\\\\\2\\\\\\\\3\\\") }V\\\"}\",\"format_version\":2,\"iam_role\":null,\"name\":\"updated-test-log-endpoint\",\"placement\":null,\"region\":\"us-east-1\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"topic\":\"my-kinesis-stream\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":1}","originalRequest":{"name":"Update the Amazon Kinesis log endpoint","description":"Update an Amazon Kinesis Data Streams logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kinesis/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","kinesis","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete the Amazon Kinesis log endpoint","request":{"name":"Delete the Amazon Kinesis log endpoint","description":"Delete an Amazon Kinesis Data Streams logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/kinesis/{{logging_kinesis_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","kinesis","{{logging_kinesis_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete the Amazon Kinesis log endpoint","description":"Delete an Amazon Kinesis Data Streams logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/kinesis/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","kinesis","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Logentries","description":"Fastly will stream log messages to the Logentries account in the format specified in the Logentries object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| port | integer | The port number. |\n| region | string | The region to which to stream logs. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| token | string | Use token based authentication ( https://logentries.com/doc/input-token/). |\n| use_tls | integer | Whether to use TLS. |\n|  | 0 | Do not use TLS. |\n|  | 1 | Use TLS. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List Logentries log endpoints","request":{"name":"List Logentries log endpoints","description":"List all of the Logentries for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/logentries","path":["service","{{service_id}}","version","{{version_id}}","logging","logentries"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"created_at\":\"2020-05-18T18:23:29.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"name\":\"test-log-endpoint\",\"placement\":null,\"port\":20000,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"token\":\"790545ca-TEST-TEST-TEST-970d1308512d\",\"updated_at\":\"2020-05-18T18:23:29.000Z\",\"use_tls\":0,\"version\":1,\"region\":\"EU\"}]","originalRequest":{"name":"List Logentries log endpoints","description":"List all of the Logentries for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/logentries","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","logentries"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a Logentries log endpoint","request":{"name":"Create a Logentries log endpoint","description":"Create a Logentry for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/logentries","path":["service","{{service_id}}","version","{{version_id}}","logging","logentries"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-05-18T18:23:29.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"name\":\"test-log-endpoint\",\"placement\":null,\"port\":20000,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"token\":\"790545ca-TEST-TEST-TEST-970d1308512d\",\"updated_at\":\"2020-05-18T18:23:29.000Z\",\"use_tls\":0,\"version\":1,\"region\":\"EU\"}","originalRequest":{"name":"Create a Logentries log endpoint","description":"Create a Logentry for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/logentries","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","logentries"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a Logentries log endpoint","request":{"name":"Get a Logentries log endpoint","description":"Get the Logentry for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/logentries/{{logging_logentries_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","logentries","{{logging_logentries_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-05-18T18:23:29.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"name\":\"test-log-endpoint\",\"placement\":null,\"port\":20000,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"token\":\"790545ca-TEST-TEST-TEST-970d1308512d\",\"updated_at\":\"2020-05-18T18:23:29.000Z\",\"use_tls\":0,\"version\":1,\"region\":\"EU\"}","originalRequest":{"name":"Get a Logentries log endpoint","description":"Get the Logentry for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/logentries/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","logentries","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a Logentries log endpoint","request":{"name":"Update a Logentries log endpoint","description":"Update the Logentry for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/logentries/{{logging_logentries_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","logentries","{{logging_logentries_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-05-18T18:23:29.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"name\":\"updated-test-log-endpoint\",\"placement\":null,\"port\":20000,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"token\":\"790545ca-TEST-TEST-TEST-970d1308512d\",\"updated_at\":\"2020-05-18T18:23:29.000Z\",\"use_tls\":0,\"version\":1,\"region\":\"EU\"}","originalRequest":{"name":"Update a Logentries log endpoint","description":"Update the Logentry for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/logentries/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","logentries","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a Logentries log endpoint","request":{"name":"Delete a Logentries log endpoint","description":"Delete the Logentry for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/logentries/{{logging_logentries_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","logentries","{{logging_logentries_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a Logentries log endpoint","description":"Delete the Logentry for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/logentries/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","logentries","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Loggly","description":"Fastly will stream log messages to the Loggly account in the format specified in the Loggly logging object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| token | string | The token to use for authentication ( https://www.loggly.com/docs/customer-token-authentication-token/). |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List Loggly log endpoints","request":{"name":"List Loggly log endpoints","description":"List all Loggly logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/loggly","path":["service","{{service_id}}","version","{{version_id}}","logging","loggly"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"response_condition\":\"\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"token\":\"test-token\",\"placement\":null}]","originalRequest":{"name":"List Loggly log endpoints","description":"List all Loggly logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/loggly","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","loggly"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a Loggly log endpoint","request":{"name":"Create a Loggly log endpoint","description":"Create a Loggly logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/loggly","path":["service","{{service_id}}","version","{{version_id}}","logging","loggly"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"response_condition\":\"\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"token\":\"test-token\",\"placement\":null}","originalRequest":{"name":"Create a Loggly log endpoint","description":"Create a Loggly logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/loggly","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","loggly"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a Loggly log endpoint","request":{"name":"Get a Loggly log endpoint","description":"Get the Loggly logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/loggly/{{logging_loggly_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","loggly","{{logging_loggly_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"response_condition\":\"\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"token\":\"test-token\",\"placement\":null}","originalRequest":{"name":"Get a Loggly log endpoint","description":"Get the Loggly logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/loggly/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","loggly","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a Loggly log endpoint","request":{"name":"Update a Loggly log endpoint","description":"Update the Loggly logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/loggly/{{logging_loggly_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","loggly","{{logging_loggly_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"name\":\"updated-test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"response_condition\":\"\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"token\":\"test-token\",\"placement\":null}","originalRequest":{"name":"Update a Loggly log endpoint","description":"Update the Loggly logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/loggly/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","loggly","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a Loggly log endpoint","request":{"name":"Delete a Loggly log endpoint","description":"Delete the Loggly logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/loggly/{{logging_loggly_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","loggly","{{logging_loggly_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a Loggly log endpoint","description":"Delete the Loggly logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/loggly/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","loggly","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Log Shuttle","description":"Fastly will upload log messages to the Log Shuttle bucket in the format specified in the logshuttle object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| token | string | The data authentication token associated with this endpoint. |\n| url | string | The URL to stream logs to. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List Log Shuttle log endpoints","request":{"name":"List Log Shuttle log endpoints","description":"List all of the Log Shuttle logging endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/logshuttle","path":["service","{{service_id}}","version","{{version_id}}","logging","logshuttle"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"created_at\":\"2020-06-02T22:31:06.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"name\":\"test-log-endpoint\",\"placement\":null,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"token\":null,\"updated_at\":\"2020-06-02T22:31:06.000Z\",\"url\":\"https://east.logplex.io/logs\",\"version\":1}]","originalRequest":{"name":"List Log Shuttle log endpoints","description":"List all of the Log Shuttle logging endpoints for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/logshuttle","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","logshuttle"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a Log Shuttle log endpoint","request":{"name":"Create a Log Shuttle log endpoint","description":"Create a Log Shuttle logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/logshuttle","path":["service","{{service_id}}","version","{{version_id}}","logging","logshuttle"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-06-02T22:31:06.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"name\":\"test-log-endpoint\",\"placement\":null,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"token\":null,\"updated_at\":\"2020-06-02T22:31:06.000Z\",\"url\":\"https://east.logplex.io/logs\",\"version\":1}","originalRequest":{"name":"Create a Log Shuttle log endpoint","description":"Create a Log Shuttle logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/logshuttle","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","logshuttle"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a Log Shuttle log endpoint","request":{"name":"Get a Log Shuttle log endpoint","description":"Get the Log Shuttle logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/logshuttle/{{logging_logshuttle_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","logshuttle","{{logging_logshuttle_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-06-02T22:31:06.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"name\":\"test-log-endpoint\",\"placement\":null,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"token\":null,\"updated_at\":\"2020-06-02T22:31:06.000Z\",\"url\":\"https://east.logplex.io/logs\",\"version\":1}","originalRequest":{"name":"Get a Log Shuttle log endpoint","description":"Get the Log Shuttle logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/logshuttle/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","logshuttle","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a Log Shuttle log endpoint","request":{"name":"Update a Log Shuttle log endpoint","description":"Update the Log Shuttle logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/logshuttle/{{logging_logshuttle_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","logshuttle","{{logging_logshuttle_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-06-02T22:31:06.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"name\":\"updated-test-log-endpoint\",\"placement\":null,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"token\":null,\"updated_at\":\"2020-06-02T22:31:06.000Z\",\"url\":\"https://east.logplex.io/logs\",\"version\":1}","originalRequest":{"name":"Update a Log Shuttle log endpoint","description":"Update the Log Shuttle logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/logshuttle/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","logshuttle","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a Log Shuttle log endpoint","request":{"name":"Delete a Log Shuttle log endpoint","description":"Delete the Log Shuttle logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/logshuttle/{{logging_logshuttle_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","logshuttle","{{logging_logshuttle_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a Log Shuttle log endpoint","description":"Delete the Log Shuttle logging endpoint for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/logshuttle/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","logshuttle","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"New Relic Logs","description":"Fastly will upload log messages to New Relic Logs in the format specified in the New Relic configuration object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| format | string | A Fastly log format string. Must produce valid JSON that New Relic Logs can ingest. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| region | string | The region to which to stream logs. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| token | string | The Insert API key from the Account page of your New Relic account. Required. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List New Relic log endpoints","request":{"name":"List New Relic log endpoints","description":"List all of the New Relic Logs logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/newrelic","path":["service","{{service_id}}","version","{{version_id}}","logging","newrelic"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"name\":\"test-log-endpoint\",\"format\":\"{\\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\\\"}\",\"format_version\":2,\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"region\":\"EU\"}]","originalRequest":{"name":"List New Relic log endpoints","description":"List all of the New Relic Logs logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/newrelic","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","newrelic"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a New Relic log endpoint","request":{"name":"Create a New Relic log endpoint","description":"Create a New Relic Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/newrelic","path":["service","{{service_id}}","version","{{version_id}}","logging","newrelic"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"name\":\"test-log-endpoint\",\"format\":\"{\\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\\\"}\",\"format_version\":2,\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"region\":\"EU\"}","originalRequest":{"name":"Create a New Relic log endpoint","description":"Create a New Relic Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/newrelic","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","newrelic"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a New Relic log endpoint","request":{"name":"Get a New Relic log endpoint","description":"Get the details of a New Relic Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/newrelic/{{logging_newrelic_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","newrelic","{{logging_newrelic_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"name\":\"test-log-endpoint\",\"format\":\"{\\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\\\"}\",\"format_version\":2,\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"region\":\"EU\"}","originalRequest":{"name":"Get a New Relic log endpoint","description":"Get the details of a New Relic Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/newrelic/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","newrelic","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a New Relic log endpoint","request":{"name":"Update a New Relic log endpoint","description":"Update a New Relic Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/newrelic/{{logging_newrelic_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","newrelic","{{logging_newrelic_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"name\":\"updated-test-log-endpoint\",\"format\":\"{\\\"time_elapsed\\\":%{time.elapsed.usec}V, \\\"is_tls\\\":%{if(req.is_ssl, \\\"true\\\", \\\"false\\\")}V, \\\"client_ip\\\":\\\"%{req.http.Fastly-Client-IP}V\\\", \\\"geo_city\\\":\\\"%{client.geo.city}V\\\", \\\"geo_country_code\\\":\\\"%{client.geo.country_code}V\\\", \\\"request\\\":\\\"%{req.request}V\\\", \\\"host\\\":\\\"%{req.http.Fastly-Orig-Host}V\\\", \\\"url\\\":\\\"%{json.escape(req.url)}V\\\", \\\"request_referer\\\":\\\"%{json.escape(req.http.Referer)}V\\\", \\\"request_user_agent\\\":\\\"%{json.escape(req.http.User-Agent)}V\\\", \\\"request_accept_language\\\":\\\"%{json.escape(req.http.Accept-Language)}V\\\", \\\"request_accept_charset\\\":\\\"%{json.escape(req.http.Accept-Charset)}V\\\", \\\"cache_status\\\":\\\"%{regsub(fastly_info.state, \\\"^(HIT-(SYNTH)|(HITPASS|HIT|MISS|PASS|ERROR|PIPE)).*\\\", \\\"\\\\2\\\\3\\\") }V\\\"}\",\"format_version\":2,\"token\":\"6f5902ac237024bdd0c176cb9306TEST\",\"response_condition\":\"\",\"created_at\":\"2020-05-17T20:23:15.000Z\",\"updated_at\":\"2020-05-17T20:23:15.000Z\",\"deleted_at\":null,\"region\":\"EU\"}","originalRequest":{"name":"Update a New Relic log endpoint","description":"Update a New Relic Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/newrelic/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","newrelic","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a New Relic log endpoint","request":{"name":"Delete a New Relic log endpoint","description":"Delete the New Relic Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/newrelic/{{logging_newrelic_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","newrelic","{{logging_newrelic_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a New Relic log endpoint","description":"Delete the New Relic Logs logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/newrelic/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","newrelic","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"OpenStack","description":"Fastly will upload log messages to the OpenStack bucket in the format specified in the openstack object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| access_key | string | Your OpenStack account access key. |\n| bucket_name | string | The name of your OpenStack container. |\n| compression_codec | string | The codec used for compressing your logs. Valid values are zstd, snappy, and gzip. Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| gzip_level | integer | The level of gzip encoding when sending logs (default 0, no compression). Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| message_type | string | How the message should be formatted. |\n|  | classic | RFC 3164 syslog prefix. |\n|  | loggly | RFC 5424 structured syslog. |\n|  | logplex | Heroku-style length prefixed syslog. |\n|  | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| path | string | The path to upload logs to. |\n| period | integer | How frequently log files are finalized so they can be available for reading (in seconds). |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| timestamp_format | string | A timestamp format. |\n| url | string | Your OpenStack auth url. |\n| user | string | The username for your OpenStack account. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List OpenStack log endpoints","request":{"name":"List OpenStack log endpoints","description":"List all of the openstacks for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/openstack","path":["service","{{service_id}}","version","{{version_id}}","logging","openstack"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-06-03T21:33:16.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":\"\",\"period\":3600,\"placement\":null,\"public_key\":null,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-06-03T21:37:21.000Z\",\"url\":\"https://auth.storage.memset.com/v1.0\",\"user\":\"Openstack Username\",\"version\":1}]","originalRequest":{"name":"List OpenStack log endpoints","description":"List all of the openstacks for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/openstack","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","openstack"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create an OpenStack log endpoint","request":{"name":"Create an OpenStack log endpoint","description":"Create a openstack for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/openstack","path":["service","{{service_id}}","version","{{version_id}}","logging","openstack"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-06-03T21:33:16.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":\"\",\"period\":3600,\"placement\":null,\"public_key\":null,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-06-03T21:37:21.000Z\",\"url\":\"https://auth.storage.memset.com/v1.0\",\"user\":\"Openstack Username\",\"version\":1}","originalRequest":{"name":"Create an OpenStack log endpoint","description":"Create a openstack for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/openstack","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","openstack"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get an OpenStack log endpoint","request":{"name":"Get an OpenStack log endpoint","description":"Get the openstack for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/openstack/{{logging_openstack_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","openstack","{{logging_openstack_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-06-03T21:33:16.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":\"\",\"period\":3600,\"placement\":null,\"public_key\":null,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-06-03T21:37:21.000Z\",\"url\":\"https://auth.storage.memset.com/v1.0\",\"user\":\"Openstack Username\",\"version\":1}","originalRequest":{"name":"Get an OpenStack log endpoint","description":"Get the openstack for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/openstack/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","openstack","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update an OpenStack log endpoint","request":{"name":"Update an OpenStack log endpoint","description":"Update the openstack for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/openstack/{{logging_openstack_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","openstack","{{logging_openstack_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-06-03T21:33:16.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"message_type\":\"classic\",\"name\":\"updated-test-log-endpoint\",\"path\":\"\",\"period\":3600,\"placement\":null,\"public_key\":null,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-06-03T21:37:21.000Z\",\"url\":\"https://auth.storage.memset.com/v1.0\",\"user\":\"Openstack Username\",\"version\":1}","originalRequest":{"name":"Update an OpenStack log endpoint","description":"Update the openstack for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/openstack/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","openstack","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete an OpenStack log endpoint","request":{"name":"Delete an OpenStack log endpoint","description":"Delete the openstack for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/openstack/{{logging_openstack_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","openstack","{{logging_openstack_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete an OpenStack log endpoint","description":"Delete the openstack for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/openstack/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","openstack","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Papertrail","description":"Fastly will stream log messages to the Papertrail account in the format specified in the Papertrail object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| address | string | A hostname or IPv4 address. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| port | integer | The port number. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List Papertrail log endpoints","request":{"name":"List Papertrail log endpoints","description":"List all of the Papertrails for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/papertrail","path":["service","{{service_id}}","version","{{version_id}}","logging","papertrail"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"address\":\"example.com\",\"created_at\":\"2020-05-18T18:51:50.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"name\":\"test-log-endpoint\",\"placement\":null,\"port\":5140,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-18T18:51:50.000Z\",\"version\":1}]","originalRequest":{"name":"List Papertrail log endpoints","description":"List all of the Papertrails for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/papertrail","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","papertrail"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a Papertrail log endpoint","request":{"name":"Create a Papertrail log endpoint","description":"Create a Papertrail for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/papertrail","path":["service","{{service_id}}","version","{{version_id}}","logging","papertrail"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"address\":\"example.com\",\"created_at\":\"2020-05-18T18:51:50.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"name\":\"test-log-endpoint\",\"placement\":null,\"port\":5140,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-18T18:51:50.000Z\",\"version\":1}","originalRequest":{"name":"Create a Papertrail log endpoint","description":"Create a Papertrail for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/papertrail","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","papertrail"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a Papertrail log endpoint","request":{"name":"Get a Papertrail log endpoint","description":"Get the Papertrail for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/papertrail/{{logging_papertrail_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","papertrail","{{logging_papertrail_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"address\":\"example.com\",\"created_at\":\"2020-05-18T18:51:50.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"name\":\"test-log-endpoint\",\"placement\":null,\"port\":5140,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-18T18:51:50.000Z\",\"version\":1}","originalRequest":{"name":"Get a Papertrail log endpoint","description":"Get the Papertrail for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/papertrail/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","papertrail","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a Papertrail log endpoint","request":{"name":"Update a Papertrail log endpoint","description":"Update the Papertrail for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/papertrail/{{logging_papertrail_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","papertrail","{{logging_papertrail_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"address\":\"example.com\",\"created_at\":\"2020-05-18T18:51:50.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"name\":\"updated-test-log-endpoint\",\"placement\":null,\"port\":5140,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-18T18:51:50.000Z\",\"version\":1}","originalRequest":{"name":"Update a Papertrail log endpoint","description":"Update the Papertrail for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/papertrail/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","papertrail","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a Papertrail log endpoint","request":{"name":"Delete a Papertrail log endpoint","description":"Delete the Papertrail for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/papertrail/{{logging_papertrail_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","papertrail","{{logging_papertrail_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a Papertrail log endpoint","description":"Delete the Papertrail for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/papertrail/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","papertrail","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"S3","description":"Fastly will upload log messages to the S3 bucket in the format specified in the S3 object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| access_key | string | The access key for your S3 account. Not required if iam_role is provided. |\n| acl | string | The access control list (ACL) specific request header. See the AWS documentation for Access Control List (ACL) Specific Request Headers for more information. |\n| bucket_name | string | The bucket name for S3 account. |\n| compression_codec | string | The codec used for compressing your logs. Valid values are zstd, snappy, and gzip. Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| domain | string | The domain of the Amazon S3 endpoint. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| gzip_level | integer | The level of gzip encoding when sending logs (default 0, no compression). Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| iam_role | string | The Amazon Resource Name (ARN) for the IAM role granting Fastly access to S3. Not required if access_key and secret_key are provided. |\n| message_type | string | How the message should be formatted. |\n|  | classic | RFC 3164 syslog prefix. |\n|  | loggly | RFC 5424 structured syslog. |\n|  | logplex | Heroku-style length prefixed syslog. |\n|  | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| path | string | The path to upload logs to. |\n| period | integer | How frequently log files are finalized so they can be available for reading (in seconds). |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. |\n| redundancy | string | The S3 redundancy level. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| secret_key | string | The secret key for your S3 account. Not required if iam_role is provided. |\n| server_side_encryption | string | Set this to AES256 or aws:kms to enable S3 Server Side Encryption. |\n| server_side_encryption_kms_key_id | string | Optional server-side KMS Key Id. Must be set if server_side_encryption is set to aws:kms or AES256. |\n| timestamp_format | string | A timestamp format. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List AWS S3 log endpoints","request":{"name":"List AWS S3 log endpoints","description":"List all of the S3s for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/s3","path":["service","{{service_id}}","version","{{version_id}}","logging","s3"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"acl\":\"\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"deleted_at\":null,\"domain\":\"s3.amazonaws.com\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"iam_role\":null,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":null,\"period\":3600,\"placement\":null,\"public_key\":null,\"redundancy\":null,\"response_condition\":\"\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":1}]","originalRequest":{"name":"List AWS S3 log endpoints","description":"List all of the S3s for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/s3","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","s3"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create an AWS S3 log endpoint","request":{"name":"Create an AWS S3 log endpoint","description":"Create a S3 for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/s3","path":["service","{{service_id}}","version","{{version_id}}","logging","s3"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"acl\":\"\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"deleted_at\":null,\"domain\":\"s3.amazonaws.com\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"iam_role\":null,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":null,\"period\":3600,\"placement\":null,\"public_key\":null,\"redundancy\":null,\"response_condition\":\"\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":1}","originalRequest":{"name":"Create an AWS S3 log endpoint","description":"Create a S3 for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/s3","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","s3"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get an AWS S3 log endpoint","request":{"name":"Get an AWS S3 log endpoint","description":"Get the S3 for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/s3/{{logging_s3_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","s3","{{logging_s3_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"acl\":\"\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"deleted_at\":null,\"domain\":\"s3.amazonaws.com\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"iam_role\":null,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"path\":null,\"period\":3600,\"placement\":null,\"public_key\":null,\"redundancy\":null,\"response_condition\":\"\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":1}","originalRequest":{"name":"Get an AWS S3 log endpoint","description":"Get the S3 for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/s3/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","s3","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update an AWS S3 log endpoint","request":{"name":"Update an AWS S3 log endpoint","description":"Update the S3 for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/s3/{{logging_s3_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","s3","{{logging_s3_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"access_key\":\"AKIAIOSFODNN7EXAMPLE\",\"acl\":\"\",\"bucket_name\":\"test-bucket\",\"created_at\":\"2020-05-23T19:48:33.000Z\",\"deleted_at\":null,\"domain\":\"s3.amazonaws.com\",\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"iam_role\":null,\"message_type\":\"classic\",\"name\":\"updated-test-log-endpoint\",\"path\":null,\"period\":3600,\"placement\":null,\"public_key\":null,\"redundancy\":null,\"response_condition\":\"\",\"secret_key\":\"wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-05-23T19:48:33.000Z\",\"version\":1}","originalRequest":{"name":"Update an AWS S3 log endpoint","description":"Update the S3 for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/s3/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","s3","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete an AWS S3 log endpoint","request":{"name":"Delete an AWS S3 log endpoint","description":"Delete the S3 for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/s3/{{logging_s3_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","s3","{{logging_s3_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete an AWS S3 log endpoint","description":"Delete the S3 for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/s3/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","s3","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Scalyr","description":"Fastly will stream log messages to the Scalyr account in the format specified in the Scalyr object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| project_id | string | The name of the logfile within Scalyr. |\n| region | string | The region that log data will be sent to. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| token | string | The token to use for authentication ( https://www.scalyr.com/keys). |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List Scalyr log endpoints","request":{"name":"List Scalyr log endpoints","description":"List all of the Scalyrs for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/scalyr","path":["service","{{service_id}}","version","{{version_id}}","logging","scalyr"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"response_condition\":\"\",\"placement\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"region\":\"US\",\"token\":\"SCALYR_KEY\",\"project_id\":\"logplex\"}]","originalRequest":{"name":"List Scalyr log endpoints","description":"List all of the Scalyrs for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/scalyr","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","scalyr"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a Scalyr log endpoint","request":{"name":"Create a Scalyr log endpoint","description":"Create a Scalyr for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/scalyr","path":["service","{{service_id}}","version","{{version_id}}","logging","scalyr"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"response_condition\":\"\",\"placement\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"region\":\"US\",\"token\":\"SCALYR_KEY\",\"project_id\":\"logplex\"}","originalRequest":{"name":"Create a Scalyr log endpoint","description":"Create a Scalyr for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/scalyr","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","scalyr"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a Scalyr log endpoint","request":{"name":"Get a Scalyr log endpoint","description":"Get the Scalyr for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/scalyr/{{logging_scalyr_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","scalyr","{{logging_scalyr_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"name\":\"test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"response_condition\":\"\",\"placement\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"region\":\"US\",\"token\":\"SCALYR_KEY\",\"project_id\":\"logplex\"}","originalRequest":{"name":"Get a Scalyr log endpoint","description":"Get the Scalyr for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/scalyr/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","scalyr","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update the Scalyr log endpoint","request":{"name":"Update the Scalyr log endpoint","description":"Update the Scalyr for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/scalyr/{{logging_scalyr_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","scalyr","{{logging_scalyr_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"name\":\"updated-test-log-endpoint\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"response_condition\":\"\",\"placement\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"region\":\"US\",\"token\":\"SCALYR_KEY\",\"project_id\":\"logplex\"}","originalRequest":{"name":"Update the Scalyr log endpoint","description":"Update the Scalyr for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/scalyr/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","scalyr","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete the Scalyr log endpoint","request":{"name":"Delete the Scalyr log endpoint","description":"Delete the Scalyr for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/scalyr/{{logging_scalyr_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","scalyr","{{logging_scalyr_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete the Scalyr log endpoint","description":"Delete the Scalyr for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/scalyr/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","scalyr","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"SFTP","description":"Fastly will upload log messages periodically to the server in the format specified in the SFTP object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| address | string | A hostname or IPv4 address. |\n| compression_codec | string | The codec used for compressing your logs. Valid values are zstd, snappy, and gzip. Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| gzip_level | integer | The level of gzip encoding when sending logs (default 0, no compression). Specifying both compression_codec and gzip_level in the same API request will result in an error. |\n| message_type | string | How the message should be formatted. |\n|  | classic | RFC 3164 syslog prefix. |\n|  | loggly | RFC 5424 structured syslog. |\n|  | logplex | Heroku-style length prefixed syslog. |\n|  | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| password | string | The password for the server. If both password and secret_key are passed, secret_key will be used in preference. |\n| path | string | The path to upload logs to. |\n| period | integer | How frequently log files are finalized so they can be available for reading (in seconds). |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| port | integer | The port number. |\n| public_key | string | A PGP public key that Fastly will use to encrypt your log files before writing them to disk. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| secret_key | string | The SSH private key for the server. If both password and secret_key are passed, secret_key will be used in preference. |\n| ssh_known_hosts | string | A list of host keys for all hosts we can connect to over SFTP. |\n| timestamp_format | string | A timestamp format. |\n| user | string | The username for the server. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List SFTP log endpoints","request":{"name":"List SFTP log endpoints","description":"List all of the SFTPs for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sftp","path":["service","{{service_id}}","version","{{version_id}}","logging","sftp"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"address\":\"example.com\",\"created_at\":\"2020-02-25T23:39:09.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"password\":\"REDACTED\",\"path\":\"/\",\"period\":3600,\"placement\":null,\"port\":22,\"public_key\":null,\"response_condition\":\"\",\"secret_key\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"ssh_known_hosts\":\"example.com ecdsa-sha2-nistp256 abc123XYX...\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-03-01T12:21:37.000Z\",\"user\":\"anonymous\",\"version\":1}]","originalRequest":{"name":"List SFTP log endpoints","description":"List all of the SFTPs for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sftp","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","sftp"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create an SFTP log endpoint","request":{"name":"Create an SFTP log endpoint","description":"Create a SFTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sftp","path":["service","{{service_id}}","version","{{version_id}}","logging","sftp"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"address\":\"example.com\",\"created_at\":\"2020-02-25T23:39:09.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"password\":\"REDACTED\",\"path\":\"/\",\"period\":3600,\"placement\":null,\"port\":22,\"public_key\":null,\"response_condition\":\"\",\"secret_key\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"ssh_known_hosts\":\"example.com ecdsa-sha2-nistp256 abc123XYX...\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-03-01T12:21:37.000Z\",\"user\":\"anonymous\",\"version\":1}","originalRequest":{"name":"Create an SFTP log endpoint","description":"Create a SFTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sftp","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","sftp"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get an SFTP log endpoint","request":{"name":"Get an SFTP log endpoint","description":"Get the SFTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sftp/{{logging_sftp_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","sftp","{{logging_sftp_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"address\":\"example.com\",\"created_at\":\"2020-02-25T23:39:09.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"password\":\"REDACTED\",\"path\":\"/\",\"period\":3600,\"placement\":null,\"port\":22,\"public_key\":null,\"response_condition\":\"\",\"secret_key\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"ssh_known_hosts\":\"example.com ecdsa-sha2-nistp256 abc123XYX...\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-03-01T12:21:37.000Z\",\"user\":\"anonymous\",\"version\":1}","originalRequest":{"name":"Get an SFTP log endpoint","description":"Get the SFTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sftp/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","sftp","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update an SFTP log endpoint","request":{"name":"Update an SFTP log endpoint","description":"Update the SFTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sftp/{{logging_sftp_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","sftp","{{logging_sftp_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"address\":\"example.com\",\"created_at\":\"2020-02-25T23:39:09.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"compression_codec\":\"zstd\",\"gzip_level\":0,\"message_type\":\"classic\",\"name\":\"updated-test-log-endpoint\",\"password\":\"REDACTED\",\"path\":\"/\",\"period\":3600,\"placement\":null,\"port\":22,\"public_key\":null,\"response_condition\":\"\",\"secret_key\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"ssh_known_hosts\":\"example.com ecdsa-sha2-nistp256 abc123XYX...\",\"timestamp_format\":\"%Y-%m-%dT%H:%M:%S.000\",\"updated_at\":\"2020-03-01T12:21:37.000Z\",\"user\":\"anonymous\",\"version\":1}","originalRequest":{"name":"Update an SFTP log endpoint","description":"Update the SFTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sftp/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","sftp","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete an SFTP log endpoint","request":{"name":"Delete an SFTP log endpoint","description":"Delete the SFTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sftp/{{logging_sftp_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","sftp","{{logging_sftp_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete an SFTP log endpoint","description":"Delete the SFTP for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sftp/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","sftp","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Splunk","description":"Fastly will POST messages to your Splunk account in the format specified in the Splunk object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| request_max_bytes | integer | The maximum number of bytes sent in one request. Defaults 0 for unbounded. |\n| request_max_entries | integer | The maximum number of logs sent in one request. Defaults 0 for unbounded. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| tls_ca_cert | string | A secure certificate to authenticate a server with. Must be in PEM format. |\n| tls_client_cert | string | The client certificate used to make authenticated requests. Must be in PEM format. |\n| tls_client_key | string | The client private key used to make authenticated requests. Must be in PEM format. |\n| tls_hostname | string | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. |\n| token | string | A Splunk token for use in posting logs over HTTP to your collector. |\n| url | string | The URL to post logs to. |\n| use_tls | integer | Whether to use TLS. |\n|  | 0 | Do not use TLS. |\n|  | 1 | Use TLS. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List Splunk log endpoints","request":{"name":"List Splunk log endpoints","description":"List all of the Splunk logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/splunk","path":["service","{{service_id}}","version","{{version_id}}","logging","splunk"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"deleted_at\":null,\"updated_at\":\"2020-08-23T19:54:52.000Z\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"url\":\"https://mysplunkendpoint.example.com/services/collector/event\",\"tls_hostname\":null,\"tls_ca_cert\":null,\"tls_client_key\":null,\"tls_client_cert\":null,\"version\":1,\"request_max_entries\":0,\"request_max_bytes\":0,\"placement\":null,\"created_at\":\"2020-08-23T19:54:52.000Z\",\"response_condition\":\"\",\"name\":\"test-log-endpoint\",\"format_version\":2,\"token\":\"test-token\",\"use_tls\":0}]","originalRequest":{"name":"List Splunk log endpoints","description":"List all of the Splunk logging objects for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/splunk","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","splunk"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a Splunk log endpoint","request":{"name":"Create a Splunk log endpoint","description":"Create a Splunk logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/splunk","path":["service","{{service_id}}","version","{{version_id}}","logging","splunk"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"deleted_at\":null,\"updated_at\":\"2020-08-23T19:54:52.000Z\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"url\":\"https://mysplunkendpoint.example.com/services/collector/event\",\"tls_hostname\":null,\"tls_ca_cert\":null,\"tls_client_key\":null,\"tls_client_cert\":null,\"version\":1,\"request_max_entries\":0,\"request_max_bytes\":0,\"placement\":null,\"created_at\":\"2020-08-23T19:54:52.000Z\",\"response_condition\":\"\",\"name\":\"test-log-endpoint\",\"format_version\":2,\"token\":\"test-token\",\"use_tls\":0}","originalRequest":{"name":"Create a Splunk log endpoint","description":"Create a Splunk logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/splunk","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","splunk"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a Splunk log endpoint","request":{"name":"Get a Splunk log endpoint","description":"Get the details for a Splunk logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/splunk/{{logging_splunk_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","splunk","{{logging_splunk_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"deleted_at\":null,\"updated_at\":\"2020-08-23T19:54:52.000Z\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"url\":\"https://mysplunkendpoint.example.com/services/collector/event\",\"tls_hostname\":null,\"tls_ca_cert\":null,\"tls_client_key\":null,\"tls_client_cert\":null,\"version\":1,\"request_max_entries\":0,\"request_max_bytes\":0,\"placement\":null,\"created_at\":\"2020-08-23T19:54:52.000Z\",\"response_condition\":\"\",\"name\":\"test-log-endpoint\",\"format_version\":2,\"token\":\"test-token\",\"use_tls\":0}","originalRequest":{"name":"Get a Splunk log endpoint","description":"Get the details for a Splunk logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/splunk/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","splunk","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a Splunk log endpoint","request":{"name":"Update a Splunk log endpoint","description":"Update the Splunk logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/splunk/{{logging_splunk_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","splunk","{{logging_splunk_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"deleted_at\":null,\"updated_at\":\"2020-08-23T19:54:52.000Z\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"url\":\"https://mysplunkendpoint.example.com/services/collector/event\",\"tls_hostname\":null,\"tls_ca_cert\":null,\"tls_client_key\":null,\"tls_client_cert\":null,\"version\":1,\"request_max_entries\":0,\"request_max_bytes\":0,\"placement\":null,\"created_at\":\"2020-08-23T19:54:52.000Z\",\"response_condition\":\"\",\"name\":\"updated-test-log-endpoint\",\"format_version\":2,\"token\":\"test-token\",\"use_tls\":0}","originalRequest":{"name":"Update a Splunk log endpoint","description":"Update the Splunk logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/splunk/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","splunk","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a Splunk log endpoint","request":{"name":"Delete a Splunk log endpoint","description":"Delete the Splunk logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/splunk/{{logging_splunk_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","splunk","{{logging_splunk_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a Splunk log endpoint","description":"Delete the Splunk logging object for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/splunk/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","splunk","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Sumologic","description":"Fastly will POST messages to the Sumo Logic account in the format specified in the Sumologic object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| message_type | string | How the message should be formatted. |\n|  | classic | RFC 3164 syslog prefix. |\n|  | loggly | RFC 5424 structured syslog. |\n|  | logplex | Heroku-style length prefixed syslog. |\n|  | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| url | string | The URL to post logs to. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List Sumologic log endpoints","request":{"name":"List Sumologic log endpoints","description":"List all of the Sumologics for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sumologic","path":["service","{{service_id}}","version","{{version_id}}","logging","sumologic"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"created_at\":\"2020-05-23T21:37:09.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"response_condition\":\"\",\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-23T21:37:09.000Z\",\"url\":\"https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/your_end_point_here\",\"version\":1}]","originalRequest":{"name":"List Sumologic log endpoints","description":"List all of the Sumologics for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sumologic","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","sumologic"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a Sumologic log endpoint","request":{"name":"Create a Sumologic log endpoint","description":"Create a Sumologic for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sumologic","path":["service","{{service_id}}","version","{{version_id}}","logging","sumologic"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-05-23T21:37:09.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"response_condition\":\"\",\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-23T21:37:09.000Z\",\"url\":\"https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/your_end_point_here\",\"version\":1}","originalRequest":{"name":"Create a Sumologic log endpoint","description":"Create a Sumologic for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sumologic","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","sumologic"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a Sumologic log endpoint","request":{"name":"Get a Sumologic log endpoint","description":"Get the Sumologic for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sumologic/{{logging_sumologic_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","sumologic","{{logging_sumologic_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-05-23T21:37:09.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"response_condition\":\"\",\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-23T21:37:09.000Z\",\"url\":\"https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/your_end_point_here\",\"version\":1}","originalRequest":{"name":"Get a Sumologic log endpoint","description":"Get the Sumologic for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sumologic/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","sumologic","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a Sumologic log endpoint","request":{"name":"Update a Sumologic log endpoint","description":"Update the Sumologic for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sumologic/{{logging_sumologic_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","sumologic","{{logging_sumologic_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-05-23T21:37:09.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"message_type\":\"classic\",\"name\":\"updated-test-log-endpoint\",\"response_condition\":\"\",\"placement\":null,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"updated_at\":\"2020-05-23T21:37:09.000Z\",\"url\":\"https://endpoint1.collection.us2.sumologic.com/receiver/v1/http/your_end_point_here\",\"version\":1}","originalRequest":{"name":"Update a Sumologic log endpoint","description":"Update the Sumologic for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sumologic/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","sumologic","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a Sumologic log endpoint","request":{"name":"Delete a Sumologic log endpoint","description":"Delete the Sumologic for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/sumologic/{{logging_sumologic_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","sumologic","{{logging_sumologic_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a Sumologic log endpoint","description":"Delete the Sumologic for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/sumologic/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","sumologic","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Syslog","description":"Fastly will stream log messages to the location in the format specified in the Syslog object.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| address | string | A hostname or IPv4 address. |\n| format | string | A Fastly log format string. |\n| format_version | integer | The version of the custom logging format used for the configured endpoint. The logging call gets placed by default in vcl_log if format_version is set to 2 and in vcl_deliver if format_version is set to 1. |\n|  | 1 | Version 1 log format. |\n|  | 2 | Version 2 log format. |\n| hostname | string | The hostname used for the syslog endpoint. |\n| ipv4 | string | The IPv4 address used for the syslog endpoint. |\n| message_type | string | How the message should be formatted. |\n|  | classic | RFC 3164 syslog prefix. |\n|  | loggly | RFC 5424 structured syslog. |\n|  | logplex | Heroku-style length prefixed syslog. |\n|  | blank | No prefix. Useful for writing JSON and CSV. |\n| name | string | The name for the real-time logging configuration. |\n| placement | string | Where in the generated VCL the logging call should be placed. If not set, endpoints with format_version of 2 are placed in vcl_log and those with format_version of 1 are placed in vcl_deliver. |\n|  | none | Do not render a log statement into VCL. Use this option if you intend to write a log statement manually. |\n|  | waf_debug | Put the log statement in the waf_debug_log subroutine, which allows for logging of WAF-specific variables. |\n| port | integer | The port number. |\n| response_condition | string | The name of an existing condition in the configured endpoint, or leave blank to always execute. |\n| tls_ca_cert | string | A secure certificate to authenticate a server with. Must be in PEM format. |\n| tls_client_cert | string | The client certificate used to make authenticated requests. Must be in PEM format. |\n| tls_client_key | string | The client private key used to make authenticated requests. Must be in PEM format. |\n| tls_hostname | string | The hostname to verify the server's certificate. This should be one of the Subject Alternative Name (SAN) fields for the certificate. Common Names (CN) are not supported. |\n| token | string | Whether to prepend each message with a specific token. |\n| use_tls | integer | Whether to use TLS. |\n|  | 0 | Do not use TLS. |\n|  | 1 | Use TLS. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List Syslog log endpoints","request":{"name":"List Syslog log endpoints","description":"List all of the Syslogs for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/syslog","path":["service","{{service_id}}","version","{{version_id}}","logging","syslog"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"address\":\"example.com\",\"created_at\":\"2020-05-26T16:41:38.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"hostname\":\"example.com\",\"ipv4\":null,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"placement\":null,\"port\":514,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"tls_ca_cert\":null,\"tls_client_cert\":null,\"tls_client_key\":null,\"tls_hostname\":null,\"token\":null,\"updated_at\":\"2020-05-26T16:41:38.000Z\",\"use_tls\":0,\"version\":1}]","originalRequest":{"name":"List Syslog log endpoints","description":"List all of the Syslogs for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/syslog","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","syslog"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a syslog log endpoint","request":{"name":"Create a syslog log endpoint","description":"Create a Syslog for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/syslog","path":["service","{{service_id}}","version","{{version_id}}","logging","syslog"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"address\":\"example.com\",\"created_at\":\"2020-05-26T16:41:38.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"hostname\":\"example.com\",\"ipv4\":null,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"placement\":null,\"port\":514,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"tls_ca_cert\":null,\"tls_client_cert\":null,\"tls_client_key\":null,\"tls_hostname\":null,\"token\":null,\"updated_at\":\"2020-05-26T16:41:38.000Z\",\"use_tls\":0,\"version\":1}","originalRequest":{"name":"Create a syslog log endpoint","description":"Create a Syslog for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/syslog","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","syslog"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a syslog log endpoint","request":{"name":"Get a syslog log endpoint","description":"Get the Syslog for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/syslog/{{logging_syslog_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","syslog","{{logging_syslog_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"address\":\"example.com\",\"created_at\":\"2020-05-26T16:41:38.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"hostname\":\"example.com\",\"ipv4\":null,\"message_type\":\"classic\",\"name\":\"test-log-endpoint\",\"placement\":null,\"port\":514,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"tls_ca_cert\":null,\"tls_client_cert\":null,\"tls_client_key\":null,\"tls_hostname\":null,\"token\":null,\"updated_at\":\"2020-05-26T16:41:38.000Z\",\"use_tls\":0,\"version\":1}","originalRequest":{"name":"Get a syslog log endpoint","description":"Get the Syslog for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/syslog/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","syslog","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a syslog log endpoint","request":{"name":"Update a syslog log endpoint","description":"Update the Syslog for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/syslog/{{logging_syslog_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","syslog","{{logging_syslog_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"address\":\"example.com\",\"created_at\":\"2020-05-26T16:41:38.000Z\",\"deleted_at\":null,\"format\":\"%h %l %u %t \\\"%r\\\" %>s %b\",\"format_version\":2,\"hostname\":\"example.com\",\"ipv4\":null,\"message_type\":\"classic\",\"name\":\"updated-test-log-endpoint\",\"placement\":null,\"port\":514,\"response_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"tls_ca_cert\":null,\"tls_client_cert\":null,\"tls_client_key\":null,\"tls_hostname\":null,\"token\":null,\"updated_at\":\"2020-05-26T16:41:38.000Z\",\"use_tls\":0,\"version\":1}","originalRequest":{"name":"Update a syslog log endpoint","description":"Update the Syslog for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/syslog/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","syslog","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a syslog log endpoint","request":{"name":"Delete a syslog log endpoint","description":"Delete the Syslog for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/logging/syslog/{{logging_syslog_name}}","path":["service","{{service_id}}","version","{{version_id}}","logging","syslog","{{logging_syslog_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a syslog log endpoint","description":"Delete the Syslog for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/logging/syslog/test-log-endpoint","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","logging","syslog","test-log-endpoint"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}]},{"name":"Domain metrics","item":[{"name":"Domain Inspector Historical API","description":"Domain Inspector provides a JSON-formatted historical API for visibility into responses delivered from your domains by Fastly. The API offers a standardized set of data to report in minutely, hourly, or daily granularity on every domain response, byte, and status code received by a specified service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| dimensions | object | The unique combination of dimensions associated with this timeseries. |\n| values | array | An array of values representing the metric values at each point in time.\nNote that this dataset is sparse: only the keys with non-zero values will be included in the record. |\n| meta | object | Meta information about the scope of the query in a human readable format. |\n| msg | string | If the query was not successful, this will provide a string that explains why. |\n| status | string | Whether or not we were able to successfully execute the query. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| bandwidth | integer | Total bytes delivered ( resp_header_bytes + resp_body_bytes + bereq_header_bytes + bereq_body_bytes). |\n| bereq_body_bytes | integer | Total body bytes sent to origin. |\n| bereq_header_bytes | integer | Total header bytes sent to origin. |\n| edge_hit_ratio | integer | Ratio of cache hits to cache misses at the edge, between 0 and 1 ( edge_hit_requests / ( edge_hit_requests + edge_miss_requests)). |\n| edge_hit_requests | integer | Number of requests sent by end users to Fastly that resulted in a hit at the edge. |\n| edge_miss_requests | integer | Number of requests sent by end users to Fastly that resulted in a miss at the edge. |\n| edge_requests | integer | Number of requests sent by end users to Fastly. |\n| edge_resp_body_bytes | integer | Total body bytes delivered from Fastly to the end user. |\n| edge_resp_header_bytes | integer | Total header bytes delivered from Fastly to the end user. |\n| origin_fetch_resp_body_bytes | integer | Total body bytes received from origin. |\n| origin_fetch_resp_header_bytes | integer | Total header bytes received from origin. |\n| origin_fetches | integer | Number of requests sent to origin. |\n| origin_offload | integer | 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). |\n| origin_status_1xx | integer | Number of \"Informational\" category status codes received from origin. |\n| origin_status_200 | integer | Number of responses received from origin with status code 200 (Success). |\n| origin_status_204 | integer | Number of responses received from origin with status code 204 (No Content). |\n| origin_status_206 | integer | Number of responses received from origin with status code 206 (Partial Content). |\n| origin_status_2xx | integer | Number of \"Success\" status codes received from origin. |\n| origin_status_301 | integer | Number of responses received from origin with status code 301 (Moved Permanently). |\n| origin_status_302 | integer | Number of responses received from origin with status code 302 (Found). |\n| origin_status_304 | integer | Number of responses received from origin with status code 304 (Not Modified). |\n| origin_status_3xx | integer | Number of \"Redirection\" codes received from origin. |\n| origin_status_400 | integer | Number of responses received from origin with status code 400 (Bad Request). |\n| origin_status_401 | integer | Number of responses received from origin with status code 401 (Unauthorized). |\n| origin_status_403 | integer | Number of responses received from origin with status code 403 (Forbidden). |\n| origin_status_404 | integer | Number of responses received from origin with status code 404 (Not Found). |\n| origin_status_416 | integer | Number of responses received from origin with status code 416 (Range Not Satisfiable). |\n| origin_status_429 | integer | Number of responses received from origin with status code 429 (Too Many Requests). |\n| origin_status_4xx | integer | Number of \"Client Error\" codes received from origin. |\n| origin_status_500 | integer | Number of responses received from origin with status code 500 (Internal Server Error). |\n| origin_status_501 | integer | Number of responses received from origin with status code 501 (Not Implemented). |\n| origin_status_502 | integer | Number of responses received from origin with status code 502 (Bad Gateway). |\n| origin_status_503 | integer | Number of responses received from origin with status code 503 (Service Unavailable). |\n| origin_status_504 | integer | Number of responses received from origin with status code 504 (Gateway Timeout). |\n| origin_status_505 | integer | Number of responses received from origin with status code 505 (HTTP Version Not Supported). |\n| origin_status_5xx | integer | Number of \"Server Error\" codes received from origin. |\n| requests | integer | Number of requests processed. |\n| resp_body_bytes | integer | Total body bytes delivered. |\n| resp_header_bytes | integer | Total header bytes delivered. |\n| status_1xx | integer | Number of 1xx \"Informational\" category status codes delivered. |\n| status_200 | integer | Number of responses received with status code 200 (Success). |\n| status_204 | integer | Number of responses received with status code 204 (No Content). |\n| status_206 | integer | Number of responses received with status code 206 (Partial Content). |\n| status_2xx | integer | Number of 2xx \"Success\" status codes delivered. |\n| status_301 | integer | Number of responses received with status code 301 (Moved Permanently). |\n| status_302 | integer | Number of responses received with status code 302 (Found). |\n| status_304 | integer | Number of responses received with status code 304 (Not Modified). |\n| status_3xx | integer | Number of 3xx \"Redirection\" codes delivered. |\n| status_400 | integer | Number of responses received with status code 400 (Bad Request). |\n| status_401 | integer | Number of responses received with status code 401 (Unauthorized). |\n| status_403 | integer | Number of responses received with status code 403 (Forbidden). |\n| status_404 | integer | Number of responses received with status code 404 (Not Found). |\n| status_416 | integer | Number of responses received with status code 416 (Range Not Satisfiable). |\n| status_429 | integer | Number of responses received with status code 429 (Too Many Requests). |\n| status_4xx | integer | Number of 4xx \"Client Error\" codes delivered. |\n| status_500 | integer | Number of responses received with status code 500 (Internal Server Error). |\n| status_501 | integer | Number of responses received with status code 501 (Not Implemented). |\n| status_502 | integer | Number of responses received with status code 502 (Bad Gateway). |\n| status_503 | integer | Number of responses received with status code 503 (Service Unavailable). |\n| status_504 | integer | Number of responses received with status code 504 (Gateway Timeout). |\n| status_505 | integer | Number of responses received with status code 505 (HTTP Version Not Supported). |\n| status_5xx | integer | Number of 5xx \"Server Error\" codes delivered. |","item":[{"name":"Get historical domain data for a service","request":{"name":"Get historical domain data for a service","description":"Fetches historical domain metrics for a given Fastly service, optionally filtering and grouping the results by domain, region, or POP.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/metrics/domains/services/{{service_id}}","path":["metrics","domains","services","{{service_id}}"],"host":["{{fastly_url}}"],"query":[{"key":"cursor","description":"Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty."},{"key":"datacenter","description":"Limit query to one or more specific POPs. Values should be comma-separated."},{"key":"domain","description":"Limit query to one or more specific domains. Values should be comma-separated."},{"key":"downsample","description":"Duration of sample windows."},{"key":"end","description":"A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided downsample value."},{"key":"group_by","description":"Dimensions to return in the query. Multiple dimensions may be separated by commas.\nFor example, group_by=domain will return one timeseries for every domain, as a total across all datacenters (POPs)."},{"key":"limit","description":"Number of results per page. The maximum is 200."},{"key":"metric","description":"The metric to retrieve. Up to ten comma-separated metrics are accepted."},{"key":"region","description":"Limit query to one or more specific geographic regions. Values should be comma-separated."},{"key":"start","description":"A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided downsample value."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"dimensions\":{\"domain\":\"domain1.com\",\"region\":\"usa\",\"datacenter\":\"SJC\"},\"values\":[{\"timestamp\":1627772400,\"resp_body_bytes\":552256,\"status_2xx\":1},{\"timestamp\":1627776000,\"resp_body_bytes\":12323,\"status_2xx\":34}]},{\"dimensions\":{\"domain\":\"sub.domain2.com\",\"region\":\"usa\",\"datacenter\":\"STP\"},\"values\":[{\"timestamp\":1627772400,\"resp_body_bytes\":221,\"status_2xx\":1},{\"timestamp\":1627776000,\"resp_body_bytes\":234,\"status_2xx\":34}]}],\"meta\":{\"start\":\"2021-08-01T00:00:00Z\",\"end\":\"2020-08-02T00:00:00Z\",\"downsample\":\"hour\",\"metric\":\"resp_body_bytes,status_2xx\",\"limit\":100,\"next_cursor\":\"VTBwRENqVTJXVmszUz\",\"sort\":\"domain,region,datacenter\",\"group_by\":\"none\",\"filters\":{}},\"status\":\"success\"}","originalRequest":{"name":"Get historical domain data for a service","description":"Fetches historical domain metrics for a given Fastly service, optionally filtering and grouping the results by domain, region, or POP.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/metrics/domains/services/SU1Z0isxPaozGVKXdv0eY?datacenter=SJC%2CSTP&domain=domain_1.com%2Cdomain_2.com&downsample=hour&end=2020-08-02T00%3A00%3A00.000Z&group_by=domain&metric=resp_body_bytes%2Cstatus_2xx&region=usa&start=2021-08-01T00%3A00%3A00.000Z","path":["metrics","domains","services","SU1Z0isxPaozGVKXdv0eY?datacenter=SJC%2CSTP&domain=domain_1.com%2Cdomain_2.com&downsample=hour&end=2020-08-02T00%3A00%3A00.000Z&group_by=domain&metric=resp_body_bytes%2Cstatus_2xx&region=usa&start=2021-08-01T00%3A00%3A00.000Z"],"host":["https://api.fastly.com"],"query":[{"key":"cursor","description":"Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty."},{"key":"datacenter","description":"Limit query to one or more specific POPs. Values should be comma-separated."},{"key":"domain","description":"Limit query to one or more specific domains. Values should be comma-separated."},{"key":"downsample","description":"Duration of sample windows."},{"key":"end","description":"A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided downsample value."},{"key":"group_by","description":"Dimensions to return in the query. Multiple dimensions may be separated by commas.\nFor example, group_by=domain will return one timeseries for every domain, as a total across all datacenters (POPs)."},{"key":"limit","description":"Number of results per page. The maximum is 200."},{"key":"metric","description":"The metric to retrieve. Up to ten comma-separated metrics are accepted."},{"key":"region","description":"Limit query to one or more specific geographic regions. Values should be comma-separated."},{"key":"start","description":"A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided downsample value."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Domain Inspector Real-time API","description":"The real-time domain metrics API allows you to programmatically retrieve per-domain delivery metrics derived from your Fastly services in one-second periods up to the last complete second.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| AggregateDelay | integer | Offset of entry timestamps from the current time due to processing time. |\n| Data | array | A list of report entries, each representing one second of time. |\n| Timestamp | integer | Value to use for subsequent requests. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| aggregated | object | Groups measurements by backend name and then by IP address. |\n| datacenter | object | Groups measurements by POP, then backend name, and then IP address. See the POPs API for details about POP identifiers. |\n| recorded | integer | The Unix timestamp at which this record's data was generated. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| bandwidth | integer | Total bytes delivered ( resp_header_bytes + resp_body_bytes + bereq_header_bytes + bereq_body_bytes). |\n| bereq_body_bytes | integer | Total body bytes sent to origin. |\n| bereq_header_bytes | integer | Total header bytes sent to origin. |\n| edge_hit_ratio | integer | Ratio of cache hits to cache misses at the edge, between 0 and 1 ( edge_hit_requests / ( edge_hit_requests + edge_miss_requests)). |\n| edge_hit_requests | integer | Number of requests sent by end users to Fastly that resulted in a hit at the edge. |\n| edge_miss_requests | integer | Number of requests sent by end users to Fastly that resulted in a miss at the edge. |\n| edge_requests | integer | Number of requests sent by end users to Fastly. |\n| edge_resp_body_bytes | integer | Total body bytes delivered from Fastly to the end user. |\n| edge_resp_header_bytes | integer | Total header bytes delivered from Fastly to the end user. |\n| origin_fetch_resp_body_bytes | integer | Total body bytes received from origin. |\n| origin_fetch_resp_header_bytes | integer | Total header bytes received from origin. |\n| origin_fetches | integer | Number of requests sent to origin. |\n| origin_offload | integer | 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). |\n| origin_status_1xx | integer | Number of \"Informational\" category status codes received from origin. |\n| origin_status_200 | integer | Number of responses received from origin with status code 200 (Success). |\n| origin_status_204 | integer | Number of responses received from origin with status code 204 (No Content). |\n| origin_status_206 | integer | Number of responses received from origin with status code 206 (Partial Content). |\n| origin_status_2xx | integer | Number of \"Success\" status codes received from origin. |\n| origin_status_301 | integer | Number of responses received from origin with status code 301 (Moved Permanently). |\n| origin_status_302 | integer | Number of responses received from origin with status code 302 (Found). |\n| origin_status_304 | integer | Number of responses received from origin with status code 304 (Not Modified). |\n| origin_status_3xx | integer | Number of \"Redirection\" codes received from origin. |\n| origin_status_400 | integer | Number of responses received from origin with status code 400 (Bad Request). |\n| origin_status_401 | integer | Number of responses received from origin with status code 401 (Unauthorized). |\n| origin_status_403 | integer | Number of responses received from origin with status code 403 (Forbidden). |\n| origin_status_404 | integer | Number of responses received from origin with status code 404 (Not Found). |\n| origin_status_416 | integer | Number of responses received from origin with status code 416 (Range Not Satisfiable). |\n| origin_status_429 | integer | Number of responses received from origin with status code 429 (Too Many Requests). |\n| origin_status_4xx | integer | Number of \"Client Error\" codes received from origin. |\n| origin_status_500 | integer | Number of responses received from origin with status code 500 (Internal Server Error). |\n| origin_status_501 | integer | Number of responses received from origin with status code 501 (Not Implemented). |\n| origin_status_502 | integer | Number of responses received from origin with status code 502 (Bad Gateway). |\n| origin_status_503 | integer | Number of responses received from origin with status code 503 (Service Unavailable). |\n| origin_status_504 | integer | Number of responses received from origin with status code 504 (Gateway Timeout). |\n| origin_status_505 | integer | Number of responses received from origin with status code 505 (HTTP Version Not Supported). |\n| origin_status_5xx | integer | Number of \"Server Error\" codes received from origin. |\n| requests | integer | Number of requests processed. |\n| resp_body_bytes | integer | Total body bytes delivered. |\n| resp_header_bytes | integer | Total header bytes delivered. |\n| status_1xx | integer | Number of 1xx \"Informational\" category status codes delivered. |\n| status_200 | integer | Number of responses received with status code 200 (Success). |\n| status_204 | integer | Number of responses received with status code 204 (No Content). |\n| status_206 | integer | Number of responses received with status code 206 (Partial Content). |\n| status_2xx | integer | Number of 2xx \"Success\" status codes delivered. |\n| status_301 | integer | Number of responses received with status code 301 (Moved Permanently). |\n| status_302 | integer | Number of responses received with status code 302 (Found). |\n| status_304 | integer | Number of responses received with status code 304 (Not Modified). |\n| status_3xx | integer | Number of 3xx \"Redirection\" codes delivered. |\n| status_400 | integer | Number of responses received with status code 400 (Bad Request). |\n| status_401 | integer | Number of responses received with status code 401 (Unauthorized). |\n| status_403 | integer | Number of responses received with status code 403 (Forbidden). |\n| status_404 | integer | Number of responses received with status code 404 (Not Found). |\n| status_416 | integer | Number of responses received with status code 416 (Range Not Satisfiable). |\n| status_429 | integer | Number of responses received with status code 429 (Too Many Requests). |\n| status_4xx | integer | Number of 4xx \"Client Error\" codes delivered. |\n| status_500 | integer | Number of responses received with status code 500 (Internal Server Error). |\n| status_501 | integer | Number of responses received with status code 501 (Not Implemented). |\n| status_502 | integer | Number of responses received with status code 502 (Bad Gateway). |\n| status_503 | integer | Number of responses received with status code 503 (Service Unavailable). |\n| status_504 | integer | Number of responses received with status code 504 (Gateway Timeout). |\n| status_505 | integer | Number of responses received with status code 505 (HTTP Version Not Supported). |\n| status_5xx | integer | Number of 5xx \"Server Error\" codes delivered. |","item":[{"name":"Get real-time domain data from a specified time","request":{"name":"Get real-time domain data from a specified time","description":"Get real-time domain data for the specified reporting period. Specify 0 to get a single entry for the last complete second. The Timestamp field included in the response provides the time index of the latest entry in the dataset and can be provided as the start_timestamp of the next request for a seamless continuation of the dataset from one request to the next.\nDue to processing latency, the earliest entry in the response dataset may be earlier than start_timestamp by the value of AggregateDelay.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/v1/domains/{{service_id}}/ts/{{start_timestamp}}","path":["v1","domains","{{service_id}}","ts","{{start_timestamp}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"Data\":[{\"datacenter\":{\"STP\":{\"www.example.com\":{\"edge\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}}},\"aggregated\":{\"www.example.com\":{\"edge\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}},\"recorded\":1589198016}],\"Timestamp\":1589198025,\"AggregateDelay\":9}","originalRequest":{"name":"Get real-time domain data from a specified time","description":"Get real-time domain data for the specified reporting period. Specify 0 to get a single entry for the last complete second. The Timestamp field included in the response provides the time index of the latest entry in the dataset and can be provided as the start_timestamp of the next request for a seamless continuation of the dataset from one request to the next.\nDue to processing latency, the earliest entry in the response dataset may be earlier than start_timestamp by the value of AggregateDelay.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/v1/domains/SU1Z0isxPaozGVKXdv0eY/ts/1608560817","path":["v1","domains","SU1Z0isxPaozGVKXdv0eY","ts","1608560817"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get real-time domain data for the last 120 seconds","request":{"name":"Get real-time domain data for the last 120 seconds","description":"Get data for the 120 seconds preceding the latest timestamp available for a service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/v1/domains/{{service_id}}/ts/h","path":["v1","domains","{{service_id}}","ts","h"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"Data\":[{\"datacenter\":{\"STP\":{\"www.example.com\":{\"edge\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}}},\"aggregated\":{\"www.example.com\":{\"edge\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}},\"recorded\":1589198016}],\"Timestamp\":1589198025,\"AggregateDelay\":9}","originalRequest":{"name":"Get real-time domain data for the last 120 seconds","description":"Get data for the 120 seconds preceding the latest timestamp available for a service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/v1/domains/SU1Z0isxPaozGVKXdv0eY/ts/h","path":["v1","domains","SU1Z0isxPaozGVKXdv0eY","ts","h"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get a limited number of real-time domain data entries","request":{"name":"Get a limited number of real-time domain data entries","description":"Get data for the max_entries seconds preceding the latest timestamp available for a service, up to a maximum of 120 entries.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/v1/domains/{{service_id}}/ts/h/limit/{{max_entries}}","path":["v1","domains","{{service_id}}","ts","h","limit","{{max_entries}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"Data\":[{\"datacenter\":{\"STP\":{\"www.example.com\":{\"edge\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}}},\"aggregated\":{\"www.example.com\":{\"edge\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}},\"recorded\":1589198016}],\"Timestamp\":1589198025,\"AggregateDelay\":9}","originalRequest":{"name":"Get a limited number of real-time domain data entries","description":"Get data for the max_entries seconds preceding the latest timestamp available for a service, up to a maximum of 120 entries.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/v1/domains/SU1Z0isxPaozGVKXdv0eY/ts/h/limit/1","path":["v1","domains","SU1Z0isxPaozGVKXdv0eY","ts","h","limit","1"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}]},{"name":"Metrics and stats","item":[{"name":"Historical Stats","description":"The Historical Stats API allows you to programmatically retrieve historical caching statistics derived from your Fastly services. You can use these metrics to help you optimize your site’s data caching and analyze your site’s traffic.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| meta | object | Meta information about the scope of the query in a human readable format. |\n| msg | string | If the query was not successful, this will provide a string that explains why. |\n| status | string | Whether or not we were able to successfully execute the query. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| attack_blocked_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule that was blocked. |\n| attack_blocked_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule that was blocked. |\n| attack_logged_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule that was logged. |\n| attack_logged_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule that was logged. |\n| attack_passed_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule that was passed. |\n| attack_passed_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule that was passed. |\n| attack_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule. |\n| attack_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule. |\n| attack_resp_synth_bytes | integer | Total bytes delivered for requests that triggered a WAF rule and returned a synthetic response. |\n| bandwidth | integer | Total bytes delivered ( resp_header_bytes + resp_body_bytes + bereq_header_bytes + bereq_body_bytes + compute_resp_header_bytes + compute_resp_body_bytes + compute_bereq_header_bytes + compute_bereq_body_bytes). |\n| bereq_body_bytes | integer | Total body bytes sent to origin. |\n| bereq_header_bytes | integer | Total header bytes sent to origin. |\n| body_size | integer | Total body bytes delivered (alias for resp_body_bytes). |\n| compute_bereq_body_bytes | integer | Total body bytes sent to backends (origins) by Compute@Edge. |\n| compute_bereq_errors | integer | Number of backend request errors, including timeouts. |\n| compute_bereq_header_bytes | integer | Total header bytes sent to backends (origins) by Compute@Edge. |\n| compute_bereqs | integer | Number of backend requests started. |\n| compute_beresp_body_bytes | integer | Total body bytes received from backends (origins) by Compute@Edge. |\n| compute_beresp_header_bytes | integer | Total header bytes received from backends (origins) by Compute@Edge. |\n| compute_execution_time_ms | number | The amount of active CPU time used to process your requests (in milliseconds). |\n| compute_globals_limit_exceeded | integer | Number of times a guest exceeded its globals limit. |\n| compute_guest_errors | integer | Number of times a service experienced a guest code error. |\n| compute_heap_limit_exceeded | integer | Number of times a guest exceeded its heap limit. |\n| compute_ram_used | integer | The amount of RAM used for your service by Fastly (in bytes). |\n| compute_req_body_bytes | integer | Total body bytes received by Compute@Edge. |\n| compute_req_header_bytes | integer | Total header bytes received by Compute@Edge. |\n| compute_request_time_ms | number | The total, actual amount of time used to process your requests, including active CPU time (in milliseconds). |\n| compute_requests | integer | The total number of requests that were received for your service by Fastly. |\n| compute_resource_limit_exceeded | integer | Number of times a guest exceeded its resource limit, includes heap, stack, globals, and code execution timeout. |\n| compute_resp_body_bytes | integer | Total body bytes sent from Compute@Edge to end user. |\n| compute_resp_header_bytes | integer | Total header bytes sent from Compute@Edge to end user. |\n| compute_resp_status_1xx | integer | Number of \"Informational\" category status codes delivered by Compute@Edge. |\n| compute_resp_status_2xx | integer | Number of \"Success\" category status codes delivered by Compute@Edge. |\n| compute_resp_status_3xx | integer | Number of \"Redirection\" category status codes delivered by Compute@Edge. |\n| compute_resp_status_4xx | integer | Number of \"Client Error\" category status codes delivered by Compute@Edge. |\n| compute_resp_status_5xx | integer | Number of \"Server Error\" category status codes delivered by Compute@Edge. |\n| compute_runtime_errors | integer | Number of times a service experienced a guest runtime error. |\n| compute_stack_limit_exceeded | integer | Number of times a guest exceeded its stack limit. |\n| deliver_sub_count | integer | Number of executions of the vcl_deliver Varnish subroutine. |\n| deliver_sub_time | number | Time spent inside the vcl_deliver Varnish subroutine (in seconds). |\n| edge_hit_requests | integer | Number of requests sent by end users to Fastly that resulted in a hit at the edge. |\n| edge_hit_resp_body_bytes | integer | Body bytes delivered for edge hits. |\n| edge_hit_resp_header_bytes | integer | Header bytes delivered for edge hits. |\n| edge_miss_requests | integer | Number of requests sent by end users to Fastly that resulted in a miss at the edge. |\n| edge_miss_resp_body_bytes | integer | Body bytes delivered for edge misses. |\n| edge_miss_resp_header_bytes | integer | Header bytes delivered for edge misses. |\n| edge_requests | integer | Number of requests sent by end users to Fastly. |\n| edge_resp_body_bytes | integer | Total body bytes delivered from Fastly to the end user. |\n| edge_resp_header_bytes | integer | Total header bytes delivered from Fastly to the end user. |\n| error_sub_count | integer | Number of executions of the vcl_error Varnish subroutine. |\n| error_sub_time | number | Time spent inside the vcl_error Varnish subroutine (in seconds). |\n| errors | integer | Number of cache errors. |\n| fanout_recv_publishes | integer | Total published messages received from the publish API endpoint. |\n| fanout_send_publishes | integer | Total published messages sent to end users. |\n| fetch_sub_count | integer | Number of executions of the vcl_fetch Varnish subroutine. |\n| fetch_sub_time | number | Time spent inside the vcl_fetch Varnish subroutine (in seconds). |\n| hash_sub_count | integer | Number of executions of the vcl_hash Varnish subroutine. |\n| hash_sub_time | number | Time spent inside the vcl_hash Varnish subroutine (in seconds). |\n| header_size | integer | Total header bytes delivered (alias for resp_header_bytes). |\n| hit_ratio | number | Ratio of cache hits to cache misses (between 0 and 1). |\n| hit_resp_body_bytes | integer | Total body bytes delivered for cache hits. |\n| hit_sub_count | integer | Number of executions of the vcl_hit Varnish subroutine. |\n| hit_sub_time | number | Time spent inside the vcl_hit Varnish subroutine (in seconds). |\n| hits | integer | Number of cache hits. |\n| hits_time | number | Total amount of time spent processing cache hits (in seconds). |\n| http2 | integer | Number of requests received over HTTP/2. |\n| http3 | integer | Number of requests received over HTTP/3. |\n| imgopto | integer | Number of responses that came from the Fastly Image Optimizer service. If the service receives 10 requests for an image, this stat will be 10 regardless of how many times the image was transformed. |\n| imgopto_resp_body_bytes | integer | Total body bytes delivered from the Fastly Image Optimizer service, including shield traffic. |\n| imgopto_resp_header_bytes | integer | Total header bytes delivered from the Fastly Image Optimizer service, including shield traffic. |\n| imgopto_shield_resp_body_bytes | integer | Total body bytes delivered via a shield from the Fastly Image Optimizer service. |\n| imgopto_shield_resp_header_bytes | integer | Total header bytes delivered via a shield from the Fastly Image Optimizer service. |\n| imgvideo | integer | Number of video responses that came from the Fastly Image Optimizer service. |\n| imgvideo_frames | integer | Number of video frames that came from the Fastly Image Optimizer service. A video frame is an individual image within a sequence of video. |\n| imgvideo_resp_body_bytes | integer | Total body bytes of video delivered from the Fastly Image Optimizer service. |\n| imgvideo_resp_header_bytes | integer | Total header bytes of video delivered from the Fastly Image Optimizer service. |\n| imgvideo_shield | integer | Number of video responses delivered via a shield that came from the Fastly Image Optimizer service. |\n| imgvideo_shield_frames | integer | Number of video frames delivered via a shield that came from the Fastly Image Optimizer service. A video frame is an individual image within a sequence of video. |\n| imgvideo_shield_resp_body_bytes | integer | Total body bytes of video delivered via a shield from the Fastly Image Optimizer service. |\n| imgvideo_shield_resp_header_bytes | integer | Total header bytes of video delivered via a shield from the Fastly Image Optimizer service. |\n| ipv6 | integer | Number of requests that were received over IPv6. |\n| log | integer | Number of log lines sent. |\n| log_bytes | integer | Total log bytes sent. |\n| miss | integer | Number of cache misses. |\n| miss_resp_body_bytes | integer | Total body bytes delivered for cache misses. |\n| miss_sub_count | integer | Number of executions of the vcl_miss Varnish subroutine. |\n| miss_sub_time | number | Time spent inside the vcl_miss Varnish subroutine (in seconds). |\n| miss_time | number | Total amount of time spent processing cache misses (in seconds). |\n| object_size_100k | integer | Number of objects served that were between 10KB and 100KB in size. |\n| object_size_100m | integer | Number of objects served that were between 10MB and 100MB in size. |\n| object_size_10k | integer | Number of objects served that were between 1KB and 10KB in size. |\n| object_size_10m | integer | Number of objects served that were between 1MB and 10MB in size. |\n| object_size_1g | integer | Number of objects served that were between 100MB and 1GB in size. |\n| object_size_1k | integer | Number of objects served that were under 1KB in size. |\n| object_size_1m | integer | Number of objects served that were between 100KB and 1MB in size. |\n| origin_cache_fetch_resp_body_bytes | integer | Body bytes received from origin for cacheable content. |\n| origin_cache_fetch_resp_header_bytes | integer | Header bytes received from an origin for cacheable content. |\n| origin_cache_fetches | integer | The total number of completed requests made to backends (origins) that returned cacheable content. |\n| origin_fetch_body_bytes | integer | Total request body bytes sent to origin. |\n| origin_fetch_header_bytes | integer | Total request header bytes sent to origin. |\n| origin_fetch_resp_body_bytes | integer | Total body bytes received from origin. |\n| origin_fetch_resp_header_bytes | integer | Total header bytes received from origin. |\n| origin_fetches | integer | Number of requests sent to origin. |\n| origin_revalidations | integer | Number of responses received from origin with a 304 status code in response to an If-Modified-Since or If-None-Match request. Under regular scenarios, a revalidation will imply a cache hit. However, if using Fastly Image Optimizer or segmented caching this may result in a cache miss. |\n| otfp | integer | Number of responses that came from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_deliver_time | number | Total amount of time spent delivering a response from the Fastly On-the-Fly Packaging service for video-on-demand (in seconds). |\n| otfp_manifests | integer | Number of responses that were manifest files from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_resp_body_bytes | integer | Total body bytes delivered from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_resp_header_bytes | integer | Total header bytes delivered from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_shield_resp_body_bytes | integer | Total body bytes delivered via a shield for the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_shield_resp_header_bytes | integer | Total header bytes delivered via a shield for the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_shield_time | number | Total amount of time spent delivering a response via a shield from the Fastly On-the-Fly Packaging service for video-on-demand (in seconds). |\n| pass | integer | Number of requests that passed through the CDN without being cached. |\n| pass_resp_body_bytes | integer | Total body bytes delivered for cache passes. |\n| pass_sub_count | integer | Number of executions of the vcl_pass Varnish subroutine. |\n| pass_sub_time | number | Time spent inside the vcl_pass Varnish subroutine (in seconds). |\n| pass_time | number | Total amount of time spent processing cache passes (in seconds). |\n| pci | integer | Number of responses with the PCI flag turned on. |\n| pipe | integer | Optional. Pipe operations performed (legacy feature). |\n| pipe_sub_count | integer | Number of executions of the vcl_pipe Varnish subroutine. |\n| pipe_sub_time | number | Time spent inside the vcl_pipe Varnish subroutine (in seconds). |\n| predeliver_sub_count | integer | Number of executions of the vcl_predeliver Varnish subroutine. |\n| predeliver_sub_time | number | Time spent inside the vcl_predeliver Varnish subroutine (in seconds). |\n| prehash_sub_count | integer | Number of executions of the vcl_prehash Varnish subroutine. |\n| prehash_sub_time | number | Time spent inside the vcl_prehash Varnish subroutine (in seconds). |\n| recv_sub_count | integer | Number of executions of the vcl_recv Varnish subroutine. |\n| recv_sub_time | number | Time spent inside the vcl_recv Varnish subroutine (in seconds). |\n| req_body_bytes | integer | Total body bytes received. |\n| req_header_bytes | integer | Total header bytes received. |\n| requests | integer | Number of requests processed. |\n| resp_body_bytes | integer | Total body bytes delivered (edge_resp_body_bytes + shield_resp_body_bytes). |\n| resp_header_bytes | integer | Total header bytes delivered (edge_resp_header_bytes + shield_resp_header_bytes). |\n| restarts | integer | Number of restarts performed. |\n| segblock_origin_fetches | integer | Number of Range requests to origin for segments of resources when using segmented caching. |\n| segblock_shield_fetches | integer | Number of Range requests to a shield for segments of resources when using segmented caching. |\n| shield | integer | Number of requests from edge to the shield POP. |\n| shield_cache_fetches | integer | The total number of completed requests made to shields that returned cacheable content. |\n| shield_fetch_body_bytes | integer | Total request body bytes sent to a shield. |\n| shield_fetch_header_bytes | integer | Total request header bytes sent to a shield. |\n| shield_fetch_resp_body_bytes | integer | Total response body bytes sent from a shield to the edge. |\n| shield_fetch_resp_header_bytes | integer | Total response header bytes sent from a shield to the edge. |\n| shield_fetches | integer | Number of requests made from one Fastly POP to another, as part of shielding. |\n| shield_hit_requests | integer | Number of requests that resulted in a hit at a shield. |\n| shield_hit_resp_body_bytes | integer | Body bytes delivered for shield hits. |\n| shield_hit_resp_header_bytes | integer | Header bytes delivered for shield hits. |\n| shield_miss_requests | integer | Number of requests that resulted in a miss at a shield. |\n| shield_miss_resp_body_bytes | integer | Body bytes delivered for shield misses. |\n| shield_miss_resp_header_bytes | integer | Header bytes delivered for shield misses. |\n| shield_resp_body_bytes | integer | Total body bytes delivered via a shield. |\n| shield_resp_header_bytes | integer | Total header bytes delivered via a shield. |\n| shield_revalidations | integer | Number of responses received from origin with a 304 status code, in response to an If-Modified-Since or If-None-Match request to a shield. Under regular scenarios, a revalidation will imply a cache hit. However, if using segmented caching this may result in a cache miss. |\n| status_1xx | integer | Number of \"Informational\" category status codes delivered. |\n| status_200 | integer | Number of responses sent with status code 200 (Success). |\n| status_204 | integer | Number of responses sent with status code 204 (No Content). |\n| status_206 | integer | Number of responses sent with status code 206 (Partial Content). |\n| status_2xx | integer | Number of \"Success\" status codes delivered. |\n| status_301 | integer | Number of responses sent with status code 301 (Moved Permanently). |\n| status_302 | integer | Number of responses sent with status code 302 (Found). |\n| status_304 | integer | Number of responses sent with status code 304 (Not Modified). |\n| status_3xx | integer | Number of \"Redirection\" codes delivered. |\n| status_400 | integer | Number of responses sent with status code 400 (Bad Request). |\n| status_401 | integer | Number of responses sent with status code 401 (Unauthorized). |\n| status_403 | integer | Number of responses sent with status code 403 (Forbidden). |\n| status_404 | integer | Number of responses sent with status code 404 (Not Found). |\n| status_416 | integer | Number of responses sent with status code 416 (Range Not Satisfiable). |\n| status_429 | integer | Number of responses sent with status code 429 (Too Many Requests). |\n| status_4xx | integer | Number of \"Client Error\" codes delivered. |\n| status_500 | integer | Number of responses sent with status code 500 (Internal Server Error). |\n| status_501 | integer | Number of responses sent with status code 501 (Not Implemented). |\n| status_502 | integer | Number of responses sent with status code 502 (Bad Gateway). |\n| status_503 | integer | Number of responses sent with status code 503 (Service Unavailable). |\n| status_504 | integer | Number of responses sent with status code 504 (Gateway Timeout). |\n| status_505 | integer | Number of responses sent with status code 505 (HTTP Version Not Supported). |\n| status_5xx | integer | Number of \"Server Error\" codes delivered. |\n| synth | integer | Number of requests that returned a synthetic response (i.e., response objects created with the synthetic VCL statement). |\n| tls | integer | Number of requests that were received over TLS. |\n| tls_handshake_sent_bytes | integer | Number of bytes transferred during TLS handshake. |\n| tls_v10 | integer | Number of requests received over TLS 1.0. |\n| tls_v11 | integer | Number of requests received over TLS 1.1. |\n| tls_v12 | integer | Number of requests received over TLS 1.2. |\n| tls_v13 | integer | Number of requests received over TLS 1.3. |\n| uncacheable | integer | Number of requests that were designated uncachable. |\n| video | integer | Number of responses with the video segment or video manifest MIME type (i.e., application/x-mpegurl, application/vnd.apple.mpegurl, application/f4m, application/dash+xml, application/vnd.ms-sstr+xml, ideo/mp2t, audio/aac, video/f4f, video/x-flv, video/mp4, audio/mp4). |\n| waf_blocked | integer | Number of requests that triggered a WAF rule and were blocked. |\n| waf_logged | integer | Number of requests that triggered a WAF rule and were logged. |\n| waf_passed | integer | Number of requests that triggered a WAF rule and were passed. |\n| websocket_req_body_bytes | integer | Total message content bytes received from end users over passthrough WebSocket connections. |\n| websocket_resp_body_bytes | integer | Total message content bytes sent to end users over passthrough WebSocket connections. |\n| websocket_resp_header_bytes | integer | Total header bytes sent to end users over passthrough WebSocket connections. |","item":[{"name":"Get historical stats","request":{"name":"Get historical stats","description":"Fetches historical stats for each of your Fastly services and groups the results by service ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/stats","path":["stats"],"host":["{{fastly_url}}"],"query":[{"key":"by","description":"Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."},{"key":"from","description":"Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."},{"key":"region","description":"Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea ( from Aug 2, 2021)\nafrica_std - Africa.\nsouthamerica_std - South America."},{"key":"to","description":"Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"success\",\"meta\":{\"to\":\"Thu May 16 20:08:35 UTC 2020\",\"from\":\"Tue May 14 20:08:35 UTC 2020\",\"by\":\"day\",\"region\":\"all\"},\"msg\":null,\"data\":{\"6ElZZvtumbwtLBDJvFwepx\":[{\"requests\":1925645,\"miss_time\":55.153864891000005,\"start_time\":1368662400,\"service_id\":\"6ElZZvtumbwtLBDJvFwepx\",\"bandwidth\":176544526854,\"hits\":1902348,\"hits_time\":520.0779119150006,\"miss\":8354,\"body_size\":175900019026,\"pass\":4212,\"header_size\":644507828,\"req_header_bytes\":2905859973,\"req_body_bytes\":390017958,\"resp_header_bytes\":644507828,\"resp_body_bytes\":175900019026,\"bereq_header_bytes\":1870557109,\"bereq_body_bytes\":389234083,\"status_200\":1208426,\"status_204\":0,\"status_301\":0,\"status_302\":0,\"status_304\":0,\"errors\":8418,\"hit_ratio\":0.9956,\"status_1xx\":0,\"status_2xx\":1208426,\"status_3xx\":0,\"status_4xx\":708801,\"status_503\":8418,\"pipe\":0,\"status_5xx\":8418,\"uncacheable\":0,\"tls\":2804069,\"shield\":208055,\"ipv6\":14156,\"otfp\":12006,\"video\":306053,\"pci\":3041,\"logging\":2088120,\"http2\":251589,\"waf_logged\":508,\"waf_blocked\":360,\"waf_passed\":0,\"attack_req_body_bytes\":1274842,\"attack_req_header_bytes\":892196,\"attack_resp_synth_bytes\":0,\"img_opto\":1404}],\"5oYej0l0heMydtjaVPOq4z\":[{\"requests\":751,\"miss_time\":1.198163271,\"start_time\":1368662400,\"service_id\":\"5oYej0l0heMydtjaVPOq4z\",\"bandwidth\":1159652,\"hits\":743,\"hits_time\":0.07059622299999999,\"miss\":8,\"body_size\":721082,\"pass\":0,\"header_size\":438570,\"req_header_bytes\":2905859973,\"req_body_bytes\":390017958,\"resp_header_bytes\":438570,\"resp_body_bytes\":721082,\"bereq_header_bytes\":1870557109,\"bereq_body_bytes\":389234083,\"status_200\":580,\"status_204\":0,\"status_301\":2,\"status_302\":0,\"status_304\":169,\"errors\":0,\"hit_ratio\":0.9893,\"status_1xx\":0,\"status_2xx\":580,\"status_3xx\":171,\"status_4xx\":0,\"status_503\":0,\"pipe\":0,\"status_5xx\":0,\"uncacheable\":0,\"tls\":2804069,\"shield\":208055,\"ipv6\":14156,\"otfp\":12006,\"video\":306053,\"pci\":3041,\"logging\":2088120,\"http2\":251589,\"waf_logged\":508,\"waf_blocked\":360,\"waf_passed\":0,\"attack_req_body_bytes\":1274842,\"attack_req_header_bytes\":892196,\"attack_resp_synth_bytes\":0,\"img_opto\":1404}]}}","originalRequest":{"name":"Get historical stats","description":"Fetches historical stats for each of your Fastly services and groups the results by service ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/stats?by=day&from=2020-04-09T18%3A14%3A30Z&region=usa&to=2020-04-09T18%3A14%3A30Z","path":["stats?by=day&from=2020-04-09T18%3A14%3A30Z&region=usa&to=2020-04-09T18%3A14%3A30Z"],"host":["https://api.fastly.com"],"query":[{"key":"by","description":"Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."},{"key":"from","description":"Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."},{"key":"region","description":"Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea ( from Aug 2, 2021)\nafrica_std - Africa.\nsouthamerica_std - South America."},{"key":"to","description":"Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get historical stats for a single field","request":{"name":"Get historical stats for a single field","description":"Fetches the specified field from the historical stats for each of your services and groups the results by service ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/stats/field/{{field}}","path":["stats","field","{{field}}"],"host":["{{fastly_url}}"],"query":[{"key":"by","description":"Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."},{"key":"from","description":"Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."},{"key":"region","description":"Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea ( from Aug 2, 2021)\nafrica_std - Africa.\nsouthamerica_std - South America."},{"key":"to","description":"Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"success\",\"meta\":{\"to\":\"Thu May 16 17:13:03 UTC 2020\",\"from\":\"Thu May 14 17:13:03 UTC 2020\",\"by\":\"day\",\"region\":\"all\"},\"msg\":null,\"data\":{\"6ElZZvtumbwtLBDJvFwepx\":[{\"service_id\":\"6ElZZvtumbwtLBDJvFwepx\",\"start_time\":\"1368720000\",\"hit_ratio\":\"0.9769\"},{\"service_id\":\"6ElZZvtumbwtLBDJvFwepx\",\"start_time\":\"1368723600\",\"hit_ratio\":\"0.9944\"}],\"5oYej0l0heMydtjaVPOq4z\":[{\"service_id\":\"5oYej0l0heMydtjaVPOq4z\",\"start_time\":\"1368716400\",\"hit_ratio\":\"0.9857\"},{\"service_id\":\"5oYej0l0heMydtjaVPOq4z\",\"start_time\":\"1368723600\",\"hit_ratio\":\"1.0000\"}]}}","originalRequest":{"name":"Get historical stats for a single field","description":"Fetches the specified field from the historical stats for each of your services and groups the results by service ID.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/stats/field/hit_ratio?by=day&from=2020-04-09T18%3A14%3A30Z&region=usa&to=2020-04-09T18%3A14%3A30Z","path":["stats","field","hit_ratio?by=day&from=2020-04-09T18%3A14%3A30Z&region=usa&to=2020-04-09T18%3A14%3A30Z"],"host":["https://api.fastly.com"],"query":[{"key":"by","description":"Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."},{"key":"from","description":"Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."},{"key":"region","description":"Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea ( from Aug 2, 2021)\nafrica_std - Africa.\nsouthamerica_std - South America."},{"key":"to","description":"Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get aggregated historical stats","request":{"name":"Get aggregated historical stats","description":"Fetches historical stats information aggregated across all of your Fastly services.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/stats/aggregate","path":["stats","aggregate"],"host":["{{fastly_url}}"],"query":[{"key":"by","description":"Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."},{"key":"from","description":"Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."},{"key":"region","description":"Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea ( from Aug 2, 2021)\nafrica_std - Africa.\nsouthamerica_std - South America."},{"key":"to","description":"Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"success\",\"meta\":{\"to\":\"Thu May 16 20:29:37 UTC 2020\",\"from\":\"Tue May 14 20:29:37 UTC 2020\",\"by\":\"day\",\"region\":\"all\"},\"msg\":null,\"data\":[{\"requests\":7022557,\"miss_time\":43342.54711368301,\"start_time\":1368576000,\"bandwidth\":33656143431,\"hits\":1851903,\"hits_time\":284.90881923000006,\"miss\":74773,\"body_size\":31118762171,\"pass\":5076669,\"header_size\":2537381260,\"req_header_bytes\":2905859973,\"req_body_bytes\":390017958,\"resp_header_bytes\":2537381260,\"resp_body_bytes\":31118762171,\"bereq_header_bytes\":1870557109,\"bereq_body_bytes\":389234083,\"status_200\":6959769,\"status_204\":0,\"status_301\":3093,\"status_302\":60,\"status_304\":14135,\"errors\":21642,\"hit_ratio\":0.9612,\"status_1xx\":0,\"status_2xx\":6959769,\"status_3xx\":17288,\"status_4xx\":23855,\"status_503\":21631,\"pipe\":0,\"status_5xx\":21642,\"uncacheable\":0,\"tls\":2804069,\"shield\":208055,\"ipv6\":14156,\"otfp\":12006,\"video\":306053,\"pci\":3041,\"logging\":2088120,\"http2\":251589,\"waf_logged\":508,\"waf_blocked\":360,\"waf_passed\":0,\"attack_req_body_bytes\":1274842,\"attack_req_header_bytes\":892196,\"attack_resp_synth_bytes\":0,\"img_opto\":1404},{\"requests\":7908607,\"miss_time\":31645.078110511986,\"start_time\":1368662400,\"bandwidth\":201478840738,\"hits\":3455867,\"hits_time\":751.2703607920007,\"miss\":114580,\"body_size\":198672905955,\"pass\":4310192,\"header_size\":2805934783,\"req_header_bytes\":2905859973,\"req_body_bytes\":390017958,\"resp_header_bytes\":2805934783,\"resp_body_bytes\":198672905955,\"bereq_header_bytes\":1870557109,\"bereq_body_bytes\":389234083,\"status_200\":7128395,\"status_204\":0,\"status_301\":2649,\"status_302\":30,\"status_304\":9920,\"errors\":41389,\"hit_ratio\":0.9679,\"status_1xx\":0,\"status_2xx\":7128395,\"status_3xx\":12599,\"status_4xx\":726224,\"status_503\":41246,\"pipe\":0,\"status_5xx\":41389,\"uncacheable\":0,\"tls\":2804069,\"shield\":208055,\"ipv6\":14156,\"otfp\":12006,\"video\":306053,\"pci\":3041,\"logging\":2088120,\"http2\":251589,\"waf_logged\":508,\"waf_blocked\":360,\"waf_passed\":0,\"attack_req_body_bytes\":1274842,\"attack_req_header_bytes\":892196,\"attack_resp_synth_bytes\":0,\"img_opto\":1404}]}","originalRequest":{"name":"Get aggregated historical stats","description":"Fetches historical stats information aggregated across all of your Fastly services.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/stats/aggregate?by=day&from=2020-04-09T18%3A14%3A30Z&region=usa&to=2020-04-09T18%3A14%3A30Z","path":["stats","aggregate?by=day&from=2020-04-09T18%3A14%3A30Z&region=usa&to=2020-04-09T18%3A14%3A30Z"],"host":["https://api.fastly.com"],"query":[{"key":"by","description":"Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."},{"key":"from","description":"Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."},{"key":"region","description":"Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea ( from Aug 2, 2021)\nafrica_std - Africa.\nsouthamerica_std - South America."},{"key":"to","description":"Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get historical stats for a single service","request":{"name":"Get historical stats for a single service","description":"Fetches historical stats for a given service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/stats/service/{{service_id}}","path":["stats","service","{{service_id}}"],"host":["{{fastly_url}}"],"query":[{"key":"by","description":"Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."},{"key":"from","description":"Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."},{"key":"region","description":"Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea ( from Aug 2, 2021)\nafrica_std - Africa.\nsouthamerica_std - South America."},{"key":"to","description":"Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"success\",\"meta\":{\"to\":\"Thu May 16 20:39:09 UTC 2020\",\"from\":\"Tue May 14 20:39:09 UTC 2020\",\"by\":\"day\",\"region\":\"all\"},\"msg\":null,\"data\":[{\"requests\":21,\"miss_time\":0,\"start_time\":1368734160,\"service_id\":\"1jlmtMz1ncwA0KC3TBGD0X\",\"bandwidth\":160238,\"hits\":0,\"hits_time\":0,\"miss\":0,\"body_size\":150948,\"pass\":19,\"header_size\":9290,\"req_header_bytes\":2905859973,\"req_body_bytes\":390017958,\"resp_header_bytes\":9290,\"resp_body_bytes\":150948,\"bereq_header_bytes\":1870557109,\"bereq_body_bytes\":389234083,\"status_200\":14,\"status_204\":0,\"status_301\":2,\"status_302\":0,\"status_304\":0,\"errors\":0,\"hit_ratio\":null,\"status_1xx\":0,\"status_2xx\":14,\"status_3xx\":2,\"status_4xx\":5,\"status_503\":0,\"pipe\":0,\"status_5xx\":0,\"uncacheable\":0,\"tls\":2804069,\"shield\":208055,\"ipv6\":14156,\"otfp\":12006,\"video\":306053,\"pci\":3041,\"logging\":2088120,\"http2\":251589,\"waf_logged\":508,\"waf_blocked\":360,\"waf_passed\":0,\"attack_req_body_bytes\":1274842,\"attack_req_header_bytes\":892196,\"attack_resp_synth_bytes\":0,\"img_opto\":1404},{\"requests\":20,\"miss_time\":0,\"start_time\":1368734220,\"service_id\":\"1jlmtMz1ncwA0KC3TBGD0X\",\"bandwidth\":156504,\"hits\":0,\"hits_time\":0,\"miss\":0,\"body_size\":147806,\"pass\":17,\"header_size\":8698,\"req_header_bytes\":2905859973,\"req_body_bytes\":390017958,\"resp_header_bytes\":8698,\"resp_body_bytes\":147806,\"bereq_header_bytes\":1870557109,\"bereq_body_bytes\":389234083,\"status_200\":12,\"status_204\":0,\"status_301\":3,\"status_302\":0,\"status_304\":0,\"errors\":0,\"hit_ratio\":null,\"status_1xx\":0,\"status_2xx\":12,\"status_3xx\":3,\"status_4xx\":5,\"status_503\":0,\"pipe\":0,\"status_5xx\":0,\"uncacheable\":0,\"tls\":2804069,\"shield\":208055,\"ipv6\":14156,\"otfp\":12006,\"video\":306053,\"pci\":3041,\"logging\":2088120,\"http2\":251589,\"waf_logged\":508,\"waf_blocked\":360,\"waf_passed\":0,\"attack_req_body_bytes\":1274842,\"attack_req_header_bytes\":892196,\"attack_resp_synth_bytes\":0,\"img_opto\":1404}]}","originalRequest":{"name":"Get historical stats for a single service","description":"Fetches historical stats for a given service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/stats/service/SU1Z0isxPaozGVKXdv0eY?by=day&from=2020-04-09T18%3A14%3A30Z&region=usa&to=2020-04-09T18%3A14%3A30Z","path":["stats","service","SU1Z0isxPaozGVKXdv0eY?by=day&from=2020-04-09T18%3A14%3A30Z&region=usa&to=2020-04-09T18%3A14%3A30Z"],"host":["https://api.fastly.com"],"query":[{"key":"by","description":"Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."},{"key":"from","description":"Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."},{"key":"region","description":"Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea ( from Aug 2, 2021)\nafrica_std - Africa.\nsouthamerica_std - South America."},{"key":"to","description":"Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get historical stats for a single service/field combination","request":{"name":"Get historical stats for a single service/field combination","description":"Fetches the specified field from the historical stats for a given service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/stats/service/{{service_id}}/field/{{field}}","path":["stats","service","{{service_id}}","field","{{field}}"],"host":["{{fastly_url}}"],"query":[{"key":"by","description":"Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."},{"key":"from","description":"Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."},{"key":"region","description":"Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea ( from Aug 2, 2021)\nafrica_std - Africa.\nsouthamerica_std - South America."},{"key":"to","description":"Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"success\",\"meta\":{\"to\":\"Thu May 16 20:39:09 UTC 2020\",\"from\":\"Tue May 14 20:39:09 UTC 2020\",\"by\":\"day\",\"region\":\"all\"},\"msg\":null,\"data\":[{\"service_id\":\"1jlmtMz1ncwA0KC3TBGD0X\",\"start_time\":\"1368576000\",\"hit_ratio\":\"0.9944\"},{\"service_id\":\"1jlmtMz1ncwA0KC3TBGD0X\",\"start_time\":\"1368662400\",\"hit_ratio\":\"1.0000\"}]}","originalRequest":{"name":"Get historical stats for a single service/field combination","description":"Fetches the specified field from the historical stats for a given service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/stats/service/SU1Z0isxPaozGVKXdv0eY/field/hit_ratio?by=day&from=2020-04-09T18%3A14%3A30Z&region=usa&to=2020-04-09T18%3A14%3A30Z","path":["stats","service","SU1Z0isxPaozGVKXdv0eY","field","hit_ratio?by=day&from=2020-04-09T18%3A14%3A30Z&region=usa&to=2020-04-09T18%3A14%3A30Z"],"host":["https://api.fastly.com"],"query":[{"key":"by","description":"Duration of sample windows. One of:\n\nhour - Group data by hour.\nminute - Group data by minute.\nday - Group data by day."},{"key":"from","description":"Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."},{"key":"region","description":"Limit query to a specific geographic region. One of:\n\nusa - North America.\neurope - Europe.\nanzac - Australia and New Zealand.\nasia - Asia.\nasia_india - India.\nasia_southkorea - South Korea ( from Aug 2, 2021)\nafrica_std - Africa.\nsouthamerica_std - South America."},{"key":"to","description":"Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get usage statistics","request":{"name":"Get usage statistics","description":"Returns usage information aggregated across all Fastly services and grouped by region. To aggregate across all Fastly services by time period, see /stats/aggregate .\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/stats/usage","path":["stats","usage"],"host":["{{fastly_url}}"],"query":[{"key":"from","description":"Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."},{"key":"to","description":"Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"success\",\"meta\":{\"to\":\"Thu May 16 20:39:09 UTC 2020\",\"from\":\"Tue May 14 20:39:09 UTC 2020\",\"by\":\"day\",\"region\":\"all\"},\"msg\":null,\"data\":{\"apac\":{\"requests\":163546563,\"compute_requests\":\"195733\",\"bandwidth\":10735282284},\"ausnz\":{\"requests\":2888860,\"compute_requests\":\"84538902\",\"bandwidth\":173220202333},\"usa\":{\"requests\":163546563,\"compute_requests\":\"337591\",\"bandwidth\":153220202333},\"europe\":{\"requests\":2888860,\"compute_requests\":\"5385905\",\"bandwidth\":10735282284}}}","originalRequest":{"name":"Get usage statistics","description":"Returns usage information aggregated across all Fastly services and grouped by region. To aggregate across all Fastly services by time period, see /stats/aggregate .\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/stats/usage?from=2020-04-09T18%3A14%3A30Z&to=2020-04-09T18%3A14%3A30Z","path":["stats","usage?from=2020-04-09T18%3A14%3A30Z&to=2020-04-09T18%3A14%3A30Z"],"host":["https://api.fastly.com"],"query":[{"key":"from","description":"Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."},{"key":"to","description":"Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get usage statistics per service","request":{"name":"Get usage statistics per service","description":"Returns usage information aggregated by service and grouped by service and region. For service stats by time period, see /stats and /stats/field/:field .\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/stats/usage_by_service","path":["stats","usage_by_service"],"host":["{{fastly_url}}"],"query":[{"key":"from","description":"Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."},{"key":"to","description":"Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"success\",\"meta\":{\"to\":\"Thu May 16 20:39:09 UTC 2020\",\"from\":\"Tue May 14 20:39:09 UTC 2020\",\"by\":\"day\",\"region\":\"all\"},\"msg\":null,\"data\":{\"apac\":{\"1iPMGAF44YgzB7sINv4KTF\":{\"requests\":60524,\"compute_requests\":51342,\"bandwidth\":6004223792},\"7mai6mbwRz0JXxhAY8ZSN2\":{\"requests\":3,\"compute_requests\":7,\"bandwidth\":1305}},\"ausnz\":{\"1iPMGAF44YgzB7sINv4KTF\":{\"requests\":101120,\"compute_requests\":53703,\"bandwidth\":1735577606},\"7mai6mbwRz0JXxhAY8ZSN2\":{\"requests\":93294,\"compute_requests\":19750608,\"bandwidth\":38109995}},\"usa\":{\"1iPMGAF44YgzB7sINv4KTF\":{\"requests\":1109033,\"compute_requests\":29148,\"bandwidth\":21642401706},\"7mai6mbwRz0JXxhAY8ZSN2\":{\"requests\":348175,\"compute_requests\":91914,\"bandwidth\":173135847}},\"europe\":{\"1iPMGAF44YgzB7sINv4KTF\":{\"requests\":567583,\"compute_requests\":84123,\"bandwidth\":14813592344},\"7mai6mbwRz0JXxhAY8ZSN2\":{\"requests\":260025,\"compute_requests\":112977,\"bandwidth\":110928988}}}}","originalRequest":{"name":"Get usage statistics per service","description":"Returns usage information aggregated by service and grouped by service and region. For service stats by time period, see /stats and /stats/field/:field .\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/stats/usage_by_service?from=2020-04-09T18%3A14%3A30Z&to=2020-04-09T18%3A14%3A30Z","path":["stats","usage_by_service?from=2020-04-09T18%3A14%3A30Z&to=2020-04-09T18%3A14%3A30Z"],"host":["https://api.fastly.com"],"query":[{"key":"from","description":"Timestamp that defines the start of the window for which to fetch statistics, including the timestamp itself. Accepts Unix timestamps, or any form of input parsable by the Chronic Ruby library, such as 'yesterday', or 'two weeks ago'. Default varies based on the value of by."},{"key":"to","description":"Timestamp that defines the end of the window for which to fetch statistics. Accepts the same formats as from."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get month-to-date usage statistics","request":{"name":"Get month-to-date usage statistics","description":"Returns month-to-date usage details for a given month and year. Usage details are aggregated by service and across all Fastly services, and then grouped by region. This endpoint does not use the from or to fields for selecting the date for which data is requested. Instead, it uses month and year integer fields. Both fields are optional and default to the current month and year respectively. When set, an optional billable_units field will convert bandwidth to GB and divide requests by 10,000.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/stats/usage_by_month","path":["stats","usage_by_month"],"host":["{{fastly_url}}"],"query":[{"key":"billable_units","description":"If true, return results as billable units."},{"key":"month","description":"2-digit month."},{"key":"year","description":"4-digit year."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"success\",\"msg\":null,\"meta\":{\"from\":\"2020-05-01 00:00:00 +0000\",\"to\":\"2020-05-31 23:59:59 +0000\",\"by\":\"day\",\"region\":\"all\"},\"data\":{\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"services\":{\"SU1Z0isxPaozGVKXdv0eY\":{\"name\":\"test-service\",\"anzac\":{\"bandwidth\":28.815130509,\"requests\":131.7256,\"compute_requests\":256.3968},\"asia\":{\"bandwidth\":180.182470562,\"requests\":965.4324,\"compute_requests\":801.6574},\"europe\":{\"bandwidth\":1230.23131801,\"requests\":6082.2894,\"compute_requests\":3334.6109},\"latam\":{\"bandwidth\":18.070301895,\"requests\":93.7146,\"compute_requests\":619.1009},\"south_africa\":{\"bandwidth\":8.77620445,\"requests\":37.9704,\"compute_requests\":33.1321},\"usa\":{\"bandwidth\":2330.717545144,\"requests\":5524.7604,\"compute_requests\":5718.4171}}},\"total\":{\"anzac\":{\"bandwidth\":28.815130509,\"requests\":131.7256,\"compute_requests\":256.3968},\"asia\":{\"bandwidth\":180.182470562,\"requests\":965.4324,\"compute_requests\":801.6574},\"europe\":{\"bandwidth\":1230.23131801,\"requests\":6082.2894,\"compute_requests\":3334.6109},\"latam\":{\"bandwidth\":18.070301895,\"requests\":93.7146,\"compute_requests\":619.1009},\"south_africa\":{\"bandwidth\":8.77620445,\"requests\":37.9704,\"compute_requests\":33.1321},\"usa\":{\"bandwidth\":2330.717545144,\"requests\":5524.7604,\"compute_requests\":5718.4171}}}}","originalRequest":{"name":"Get month-to-date usage statistics","description":"Returns month-to-date usage details for a given month and year. Usage details are aggregated by service and across all Fastly services, and then grouped by region. This endpoint does not use the from or to fields for selecting the date for which data is requested. Instead, it uses month and year integer fields. Both fields are optional and default to the current month and year respectively. When set, an optional billable_units field will convert bandwidth to GB and divide requests by 10,000.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens), Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/stats/usage_by_month?billable_units=true&month=05&year=2020","path":["stats","usage_by_month?billable_units=true&month=05&year=2020"],"host":["https://api.fastly.com"],"query":[{"key":"billable_units","description":"If true, return results as billable units."},{"key":"month","description":"2-digit month."},{"key":"year","description":"4-digit year."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get region codes","request":{"name":"Get region codes","description":"Fetches the list of codes for regions that are covered by the Fastly CDN service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/stats/regions","path":["stats","regions"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"success\",\"meta\":{\"to\":\"Thu May 16 20:39:09 UTC 2020\",\"from\":\"Tue May 14 20:39:09 UTC 2020\",\"by\":\"day\",\"region\":\"all\"},\"msg\":null,\"data\":[\"apac\",\"ausnz\",\"usa\",\"europe\"]}","originalRequest":{"name":"Get region codes","description":"Fetches the list of codes for regions that are covered by the Fastly CDN service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/stats/regions","path":["stats","regions"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Real-time analytics","description":"The real-time analytics API offers a standardized set of data about traffic received by a specified service in one-second time periods up to the last complete second.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| AggregateDelay | integer | How long the system will wait before aggregating messages for each second. The most recent data returned will have happened at the moment of the request, minus the aggregation delay. |\n| Data | array | A list of records, each representing one second of time. |\n| Timestamp | integer | Value to use for subsequent requests. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| aggregated | object | Aggregates measurements across all Fastly POPs. |\n| datacenter | object | Groups measurements by POP. See the POPs API for details of POP identifiers. |\n| recorded | integer | The Unix timestamp at which this record's data was generated. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| attack_blocked_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule that was blocked. |\n| attack_blocked_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule that was blocked. |\n| attack_logged_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule that was logged. |\n| attack_logged_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule that was logged. |\n| attack_passed_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule that was passed. |\n| attack_passed_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule that was passed. |\n| attack_req_body_bytes | integer | Total body bytes received from requests that triggered a WAF rule. |\n| attack_req_header_bytes | integer | Total header bytes received from requests that triggered a WAF rule. |\n| attack_resp_synth_bytes | integer | Total bytes delivered for requests that triggered a WAF rule and returned a synthetic response. |\n| bereq_body_bytes | integer | Total body bytes sent to origin. |\n| bereq_header_bytes | integer | Total header bytes sent to origin. |\n| body_size | integer | Total body bytes delivered (alias for resp_body_bytes). |\n| compute_bereq_body_bytes | integer | Total body bytes sent to backends (origins) by Compute@Edge. |\n| compute_bereq_errors | integer | Number of backend request errors, including timeouts. |\n| compute_bereq_header_bytes | integer | Total header bytes sent to backends (origins) by Compute@Edge. |\n| compute_bereqs | integer | Number of backend requests started. |\n| compute_beresp_body_bytes | integer | Total body bytes received from backends (origins) by Compute@Edge. |\n| compute_beresp_header_bytes | integer | Total header bytes received from backends (origins) by Compute@Edge. |\n| compute_execution_time_ms | number | The amount of active CPU time used to process your requests (in milliseconds). |\n| compute_globals_limit_exceeded | integer | Number of times a guest exceeded its globals limit. |\n| compute_guest_errors | integer | Number of times a service experienced a guest code error. |\n| compute_heap_limit_exceeded | integer | Number of times a guest exceeded its heap limit. |\n| compute_ram_used | integer | The amount of RAM used for your service by Fastly (in bytes). |\n| compute_req_body_bytes | integer | Total body bytes received by Compute@Edge. |\n| compute_req_header_bytes | integer | Total header bytes received by Compute@Edge. |\n| compute_request_time_ms | number | The total, actual amount of time used to process your requests, including active CPU time (in milliseconds). |\n| compute_requests | integer | The total number of requests that were received for your service by Fastly. |\n| compute_resource_limit_exceeded | integer | Number of times a guest exceeded its resource limit, includes heap, stack, globals, and code execution timeout. |\n| compute_resp_body_bytes | integer | Total body bytes sent from Compute@Edge to end user. |\n| compute_resp_header_bytes | integer | Total header bytes sent from Compute@Edge to end user. |\n| compute_resp_status_1xx | integer | Number of \"Informational\" category status codes delivered by Compute@Edge. |\n| compute_resp_status_2xx | integer | Number of \"Success\" category status codes delivered by Compute@Edge. |\n| compute_resp_status_3xx | integer | Number of \"Redirection\" category status codes delivered by Compute@Edge. |\n| compute_resp_status_4xx | integer | Number of \"Client Error\" category status codes delivered by Compute@Edge. |\n| compute_resp_status_5xx | integer | Number of \"Server Error\" category status codes delivered by Compute@Edge. |\n| compute_runtime_errors | integer | Number of times a service experienced a guest runtime error. |\n| compute_stack_limit_exceeded | integer | Number of times a guest exceeded its stack limit. |\n| deliver_sub_count | integer | Number of executions of the vcl_deliver Varnish subroutine. |\n| deliver_sub_time | number | Time spent inside the vcl_deliver Varnish subroutine (in nanoseconds). |\n| edge_hit_requests | integer | Number of requests sent by end users to Fastly that resulted in a hit at the edge. |\n| edge_hit_resp_body_bytes | integer | Body bytes delivered for edge hits. |\n| edge_hit_resp_header_bytes | integer | Header bytes delivered for edge hits. |\n| edge_miss_requests | integer | Number of requests sent by end users to Fastly that resulted in a miss at the edge. |\n| edge_miss_resp_body_bytes | integer | Body bytes delivered for edge misses. |\n| edge_miss_resp_header_bytes | integer | Header bytes delivered for edge misses. |\n| edge_requests | integer | Number of requests sent by end users to Fastly. |\n| edge_resp_body_bytes | integer | Total body bytes delivered from Fastly to the end user. |\n| edge_resp_header_bytes | integer | Total header bytes delivered from Fastly to the end user. |\n| error_sub_count | integer | Number of executions of the vcl_error Varnish subroutine. |\n| error_sub_time | number | Time spent inside the vcl_error Varnish subroutine (in nanoseconds). |\n| errors | integer | Number of cache errors. |\n| fanout_recv_publishes | integer | Total published messages received from the publish API endpoint. |\n| fanout_send_publishes | integer | Total published messages sent to end users. |\n| fetch_sub_count | integer | Number of executions of the vcl_fetch Varnish subroutine. |\n| fetch_sub_time | number | Time spent inside the vcl_fetch Varnish subroutine (in nanoseconds). |\n| hash_sub_count | integer | Number of executions of the vcl_hash Varnish subroutine. |\n| hash_sub_time | number | Time spent inside the vcl_hash Varnish subroutine (in nanoseconds). |\n| header_size | integer | Total header bytes delivered (alias for resp_header_bytes). |\n| hit_resp_body_bytes | integer | Total body bytes delivered for cache hits. |\n| hit_sub_count | integer | Number of executions of the vcl_hit Varnish subroutine. |\n| hit_sub_time | number | Time spent inside the vcl_hit Varnish subroutine (in nanoseconds). |\n| hits | integer | Number of cache hits. |\n| hits_time | number | Total amount of time spent processing cache hits (in seconds). |\n| http2 | integer | Number of requests received over HTTP/2. |\n| http3 | integer | Number of requests received over HTTP/3. |\n| imgopto | integer | Number of responses that came from the Fastly Image Optimizer service. If the service receives 10 requests for an image, this stat will be 10 regardless of how many times the image was transformed. |\n| imgopto_resp_body_bytes | integer | Total body bytes delivered from the Fastly Image Optimizer service, including shield traffic. |\n| imgopto_resp_header_bytes | integer | Total header bytes delivered from the Fastly Image Optimizer service, including shield traffic. |\n| imgopto_shield | integer | Number of responses that came from the Fastly Image Optimizer service via a shield. |\n| imgopto_shield_resp_body_bytes | integer | Total body bytes delivered via a shield from the Fastly Image Optimizer service. |\n| imgopto_shield_resp_header_bytes | integer | Total header bytes delivered via a shield from the Fastly Image Optimizer service. |\n| imgopto_transforms | integer | Number of transforms performed by the Fastly Image Optimizer service. |\n| imgvideo | integer | Number of video responses that came from the Fastly Image Optimizer service. |\n| imgvideo_frames | integer | Number of video frames that came from the Fastly Image Optimizer service. A video frame is an individual image within a sequence of video. |\n| imgvideo_resp_body_bytes | integer | Total body bytes of video delivered from the Fastly Image Optimizer service. |\n| imgvideo_resp_header_bytes | integer | Total header bytes of video delivered from the Fastly Image Optimizer service. |\n| imgvideo_shield | integer | Number of video responses delivered via a shield that came from the Fastly Image Optimizer service. |\n| imgvideo_shield_frames | integer | Number of video frames delivered via a shield that came from the Fastly Image Optimizer service. A video frame is an individual image within a sequence of video. |\n| imgvideo_shield_resp_body_bytes | integer | Total body bytes of video delivered via a shield from the Fastly Image Optimizer service. |\n| imgvideo_shield_resp_header_bytes | integer | Total header bytes of video delivered via a shield from the Fastly Image Optimizer service. |\n| ipv6 | integer | Number of requests that were received over IPv6. |\n| log | integer | Number of log lines sent. |\n| log_bytes | integer | Total log bytes sent. |\n| logging | integer | Number of log lines sent (alias for log). |\n| miss | integer | Number of cache misses. |\n| miss_histogram | object | A histogram. Each key represents the upper bound of a span of 10 milliseconds and the values represent the number of requests to origin during that 10ms period. Any origin request that takes more than 60 seconds to return will be in the 60000 bucket. |\n| miss_resp_body_bytes | integer | Total body bytes delivered for cache misses. |\n| miss_sub_count | integer | Number of executions of the vcl_miss Varnish subroutine. |\n| miss_sub_time | number | Time spent inside the vcl_miss Varnish subroutine (in nanoseconds). |\n| miss_time | number | Total amount of time spent processing cache misses (in seconds). |\n| object_size_100k | integer | Number of objects served that were between 10KB and 100KB in size. |\n| object_size_100m | integer | Number of objects served that were between 10MB and 100MB in size. |\n| object_size_10k | integer | Number of objects served that were between 1KB and 10KB in size. |\n| object_size_10m | integer | Number of objects served that were between 1MB and 10MB in size. |\n| object_size_1g | integer | Number of objects served that were between 100MB and 1GB in size. |\n| object_size_1k | integer | Number of objects served that were under 1KB in size. |\n| object_size_1m | integer | Number of objects served that were between 100KB and 1MB in size. |\n| object_size_other | integer | Number of objects served that were larger than 1GB in size. |\n| origin_cache_fetch_resp_body_bytes | integer | Body bytes received from origin for cacheable content. |\n| origin_cache_fetch_resp_header_bytes | integer | Header bytes received from an origin for cacheable content. |\n| origin_cache_fetches | integer | The total number of completed requests made to backends (origins) that returned cacheable content. |\n| origin_fetch_body_bytes | integer | Total request body bytes sent to origin. |\n| origin_fetch_header_bytes | integer | Total request header bytes sent to origin. |\n| origin_fetch_resp_body_bytes | integer | Total body bytes received from origin. |\n| origin_fetch_resp_header_bytes | integer | Total header bytes received from origin. |\n| origin_fetches | integer | Number of requests sent to origin. |\n| origin_revalidations | integer | Number of responses received from origin with a 304 status code in response to an If-Modified-Since or If-None-Match request. Under regular scenarios, a revalidation will imply a cache hit. However, if using Fastly Image Optimizer or segmented caching this may result in a cache miss. |\n| otfp | integer | Number of responses that came from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_deliver_time | number | Total amount of time spent delivering a response from the Fastly On-the-Fly Packaging service for video-on-demand (in seconds). |\n| otfp_manifests | integer | Number of responses that were manifest files from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_resp_body_bytes | integer | Total body bytes delivered from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_resp_header_bytes | integer | Total header bytes delivered from the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_shield | integer | Number of responses that came from the Fastly On-the-Fly Packaging service for video-on-demand via a shield. |\n| otfp_shield_resp_body_bytes | integer | Total body bytes delivered via a shield for the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_shield_resp_header_bytes | integer | Total header bytes delivered via a shield for the Fastly On-the-Fly Packaging service for video-on-demand. |\n| otfp_shield_time | number | Total amount of time spent delivering a response via a shield from the Fastly On-the-Fly Packaging service for video-on-demand (in seconds). |\n| pass | integer | Number of requests that passed through the CDN without being cached. |\n| pass_resp_body_bytes | integer | Total body bytes delivered for cache passes. |\n| pass_sub_count | integer | Number of executions of the vcl_pass Varnish subroutine. |\n| pass_sub_time | number | Time spent inside the vcl_pass Varnish subroutine (in nanoseconds). |\n| pass_time | number | Total amount of time spent processing cache passes (in seconds). |\n| pci | integer | Number of responses with the PCI flag turned on. |\n| pipe_sub_count | integer | Number of executions of the vcl_pipe Varnish subroutine. |\n| pipe_sub_time | number | Time spent inside the vcl_pipe Varnish subroutine (in nanoseconds). |\n| predeliver_sub_count | integer | Number of executions of the vcl_predeliver Varnish subroutine. |\n| predeliver_sub_time | number | Time spent inside the vcl_predeliver Varnish subroutine (in nanoseconds). |\n| prehash_sub_count | integer | Number of executions of the vcl_prehash Varnish subroutine. |\n| prehash_sub_time | number | Time spent inside the vcl_prehash Varnish subroutine (in nanoseconds). |\n| recv_sub_count | integer | Number of executions of the vcl_recv Varnish subroutine. |\n| recv_sub_time | number | Time spent inside the vcl_recv Varnish subroutine (in nanoseconds). |\n| req_body_bytes | integer | Total body bytes received. |\n| req_header_bytes | integer | Total header bytes received. |\n| requests | integer | Number of requests processed. |\n| resp_body_bytes | integer | Total body bytes delivered (edge_resp_body_bytes + shield_resp_body_bytes). |\n| resp_header_bytes | integer | Total header bytes delivered (edge_resp_header_bytes + shield_resp_header_bytes). |\n| restarts | integer | Number of restarts performed. |\n| segblock_origin_fetches | integer | Number of Range requests to origin for segments of resources when using segmented caching. |\n| segblock_shield_fetches | integer | Number of Range requests to a shield for segments of resources when using segmented caching. |\n| shield | integer | Number of requests from edge to the shield POP. |\n| shield_cache_fetches | integer | The total number of completed requests made to shields that returned cacheable content. |\n| shield_fetch_body_bytes | integer | Total request body bytes sent to a shield. |\n| shield_fetch_header_bytes | integer | Total request header bytes sent to a shield. |\n| shield_fetch_resp_body_bytes | integer | Total response body bytes sent from a shield to the edge. |\n| shield_fetch_resp_header_bytes | integer | Total response header bytes sent from a shield to the edge. |\n| shield_fetches | integer | Number of requests made from one Fastly POP to another, as part of shielding. |\n| shield_hit_requests | integer | Number of requests that resulted in a hit at a shield. |\n| shield_hit_resp_body_bytes | integer | Body bytes delivered for shield hits. |\n| shield_hit_resp_header_bytes | integer | Header bytes delivered for shield hits. |\n| shield_miss_requests | integer | Number of requests that resulted in a miss at a shield. |\n| shield_miss_resp_body_bytes | integer | Body bytes delivered for shield misses. |\n| shield_miss_resp_header_bytes | integer | Header bytes delivered for shield misses. |\n| shield_resp_body_bytes | integer | Total body bytes delivered via a shield. |\n| shield_resp_header_bytes | integer | Total header bytes delivered via a shield. |\n| shield_revalidations | integer | Number of responses received from origin with a 304 status code, in response to an If-Modified-Since or If-None-Match request to a shield. Under regular scenarios, a revalidation will imply a cache hit. However, if using segmented caching this may result in a cache miss. |\n| status_1xx | integer | Number of \"Informational\" category status codes delivered. |\n| status_200 | integer | Number of responses sent with status code 200 (Success). |\n| status_204 | integer | Number of responses sent with status code 204 (No Content). |\n| status_206 | integer | Number of responses sent with status code 206 (Partial Content). |\n| status_2xx | integer | Number of \"Success\" status codes delivered. |\n| status_301 | integer | Number of responses sent with status code 301 (Moved Permanently). |\n| status_302 | integer | Number of responses sent with status code 302 (Found). |\n| status_304 | integer | Number of responses sent with status code 304 (Not Modified). |\n| status_3xx | integer | Number of \"Redirection\" codes delivered. |\n| status_400 | integer | Number of responses sent with status code 400 (Bad Request). |\n| status_401 | integer | Number of responses sent with status code 401 (Unauthorized). |\n| status_403 | integer | Number of responses sent with status code 403 (Forbidden). |\n| status_404 | integer | Number of responses sent with status code 404 (Not Found). |\n| status_416 | integer | Number of responses sent with status code 416 (Range Not Satisfiable). |\n| status_429 | integer | Number of responses sent with status code 429 (Too Many Requests). |\n| status_4xx | integer | Number of \"Client Error\" codes delivered. |\n| status_500 | integer | Number of responses sent with status code 500 (Internal Server Error). |\n| status_501 | integer | Number of responses sent with status code 501 (Not Implemented). |\n| status_502 | integer | Number of responses sent with status code 502 (Bad Gateway). |\n| status_503 | integer | Number of responses sent with status code 503 (Service Unavailable). |\n| status_504 | integer | Number of responses sent with status code 504 (Gateway Timeout). |\n| status_505 | integer | Number of responses sent with status code 505 (HTTP Version Not Supported). |\n| status_5xx | integer | Number of \"Server Error\" codes delivered. |\n| synth | integer | Number of requests that returned a synthetic response (i.e., response objects created with the synthetic VCL statement). |\n| tls | integer | Number of requests that were received over TLS. |\n| tls_v10 | integer | Number of requests received over TLS 1.0. |\n| tls_v11 | integer | Number of requests received over TLS 1.1. |\n| tls_v12 | integer | Number of requests received over TLS 1.2. |\n| tls_v13 | integer | Number of requests received over TLS 1.3. |\n| uncacheable | integer | Number of requests that were designated uncachable. |\n| video | integer | Number of responses with the video segment or video manifest MIME type (i.e., application/x-mpegurl, application/vnd.apple.mpegurl, application/f4m, application/dash+xml, application/vnd.ms-sstr+xml, ideo/mp2t, audio/aac, video/f4f, video/x-flv, video/mp4, audio/mp4). |\n| waf_blocked | integer | Number of requests that triggered a WAF rule and were blocked. |\n| waf_logged | integer | Number of requests that triggered a WAF rule and were logged. |\n| waf_passed | integer | Number of requests that triggered a WAF rule and were passed. |\n| websocket_req_body_bytes | integer | Total message content bytes received from end users over passthrough WebSocket connections. |\n| websocket_resp_body_bytes | integer | Total message content bytes sent to end users over passthrough WebSocket connections. |\n| websocket_resp_header_bytes | integer | Total header bytes sent to end users over passthrough WebSocket connections. |","item":[{"name":"Get real-time data from specified time","request":{"name":"Get real-time data from specified time","description":"Get real-time data for the specified reporting period. Specify 0 to get a single entry for the last complete second. The Timestamp field included in the response provides the time index of the latest entry in the dataset and can be provided as the start_timestamp of the next request for a seamless continuation of the dataset from one request to the next.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/v1/channel/{{service_id}}/ts/{{timestamp_in_seconds}}","path":["v1","channel","{{service_id}}","ts","{{timestamp_in_seconds}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"Data\":[{\"datacenter\":{\"LCY\":{\"requests\":0,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1}},\"aggregated\":{\"requests\":0,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1},\"recorded\":1608560817},{\"datacenter\":{\"STP\":{\"requests\":0,\"logging\":2,\"log\":2,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1,\"compute_execution_time_ms\":725,\"compute_ram_used\":24379392,\"compute_request_time_ms\":732}},\"aggregated\":{\"requests\":0,\"logging\":2,\"log\":2,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1,\"compute_execution_time_ms\":725,\"compute_ram_used\":24379392,\"compute_request_time_ms\":732},\"recorded\":1608560818}],\"Timestamp\":1608560827,\"AggregateDelay\":9}","originalRequest":{"name":"Get real-time data from specified time","description":"Get real-time data for the specified reporting period. Specify 0 to get a single entry for the last complete second. The Timestamp field included in the response provides the time index of the latest entry in the dataset and can be provided as the start_timestamp of the next request for a seamless continuation of the dataset from one request to the next.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/v1/channel/SU1Z0isxPaozGVKXdv0eY/ts/1608560817","path":["v1","channel","SU1Z0isxPaozGVKXdv0eY","ts","1608560817"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get real-time data for the last 120 seconds","request":{"name":"Get real-time data for the last 120 seconds","description":"Get data for the 120 seconds preceding the latest timestamp available for a service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/v1/channel/{{service_id}}/ts/h","path":["v1","channel","{{service_id}}","ts","h"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"Data\":[{\"datacenter\":{\"LCY\":{\"requests\":0,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1}},\"aggregated\":{\"requests\":0,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1},\"recorded\":1608560817},{\"datacenter\":{\"STP\":{\"requests\":0,\"logging\":2,\"log\":2,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1,\"compute_execution_time_ms\":725,\"compute_ram_used\":24379392,\"compute_request_time_ms\":732}},\"aggregated\":{\"requests\":0,\"logging\":2,\"log\":2,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1,\"compute_execution_time_ms\":725,\"compute_ram_used\":24379392,\"compute_request_time_ms\":732},\"recorded\":1608560818}],\"Timestamp\":1608560827,\"AggregateDelay\":9}","originalRequest":{"name":"Get real-time data for the last 120 seconds","description":"Get data for the 120 seconds preceding the latest timestamp available for a service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/v1/channel/SU1Z0isxPaozGVKXdv0eY/ts/h","path":["v1","channel","SU1Z0isxPaozGVKXdv0eY","ts","h"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get a limited number of real-time data entries","request":{"name":"Get a limited number of real-time data entries","description":"Get data for the 120 seconds preceding the latest timestamp available for a service, up to a maximum of max_entries entries.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/v1/channel/{{service_id}}/ts/h/limit/{{max_entries}}","path":["v1","channel","{{service_id}}","ts","h","limit","{{max_entries}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"Data\":[{\"datacenter\":{\"LCY\":{\"requests\":0,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1}},\"aggregated\":{\"requests\":0,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1},\"recorded\":1608560817},{\"datacenter\":{\"STP\":{\"requests\":0,\"logging\":2,\"log\":2,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1,\"compute_execution_time_ms\":725,\"compute_ram_used\":24379392,\"compute_request_time_ms\":732}},\"aggregated\":{\"requests\":0,\"logging\":2,\"log\":2,\"resp_header_bytes\":0,\"header_size\":0,\"resp_body_bytes\":0,\"body_size\":0,\"hits\":0,\"miss\":0,\"pass\":0,\"synth\":0,\"errors\":0,\"hits_time\":0,\"miss_time\":0,\"miss_histogram\":{},\"compute_requests\":1,\"compute_execution_time_ms\":725,\"compute_ram_used\":24379392,\"compute_request_time_ms\":732},\"recorded\":1608560818}],\"Timestamp\":1608560827,\"AggregateDelay\":9}","originalRequest":{"name":"Get a limited number of real-time data entries","description":"Get data for the 120 seconds preceding the latest timestamp available for a service, up to a maximum of max_entries entries.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/v1/channel/SU1Z0isxPaozGVKXdv0eY/ts/h/limit/1","path":["v1","channel","SU1Z0isxPaozGVKXdv0eY","ts","h","limit","1"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Stats","description":"Stats give you information on the usage and performance of your Service. They can be requested by Service and over a particular time span. Stats are broken down per POP, giving you information on how your Services are being used across the world. There is now a more flexible, and fully featured Stats API available.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n","item":[{"name":"Get stats for a service","request":{"name":"Get stats for a service","description":"Get the stats from a service for a block of time. This lists all stats by PoP location, starting with AMS. This call requires parameters to select block of time to query. Use either a timestamp range (using start_time and end_time) or a specified month/year combo (using month and year).\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/stats/summary","path":["service","{{service_id}}","stats","summary"],"host":["{{fastly_url}}"],"query":[{"key":"end_time","description":"Epoch timestamp. Limits the results returned."},{"key":"month","description":"2-digit month."},{"key":"start_time","description":"Epoch timestamp. Limits the results returned."},{"key":"year","description":"4-digit year."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"stats\":{\"LHR\":{\"resp_header_bytes\":0,\"resp_body_bytes\":0,\"requests\":0,\"hits\":0,\"miss\":0,\"uncacheable\":0,\"restarts\":0,\"pass\":0,\"pass_time\":0,\"pipe\":0,\"synth\":0,\"hits_time\":0,\"miss_time\":0,\"status_1xx\":0,\"status_2xx\":0,\"status_3xx\":0,\"status_4xx\":0,\"status_5xx\":0,\"status_200\":0,\"status_204\":0,\"status_206\":0,\"status_301\":0,\"status_302\":0,\"status_304\":0,\"status_400\":0,\"status_401\":0,\"status_403\":0,\"status_404\":0,\"status_416\":0,\"status_429\":0,\"status_500\":0,\"status_501\":0,\"status_502\":0,\"status_503\":0,\"status_504\":0,\"status_505\":0,\"attack_req_header_bytes\":0,\"attack_req_body_bytes\":0,\"attack_logged_req_header_bytes\":0,\"attack_logged_req_body_bytes\":0,\"attack_blocked_req_header_bytes\":0,\"attack_blocked_req_body_bytes\":0,\"attack_passed_req_header_bytes\":0,\"attack_passed_req_body_bytes\":0,\"attack_resp_synth_bytes\":0,\"waf_blocked\":0,\"waf_logged\":0,\"waf_passed\":0,\"bereq_header_bytes\":0,\"bereq_body_bytes\":0,\"req_header_bytes\":0,\"req_body_bytes\":0,\"blacklist\":0,\"tls\":0,\"tls_v10\":0,\"tls_v11\":0,\"tls_v12\":0,\"tls_v13\":0,\"shield\":0,\"shield_resp_header_bytes\":0,\"shield_resp_body_bytes\":0,\"ipv6\":0,\"http2\":0,\"pci\":0,\"object_size_1k\":0,\"object_size_10k\":0,\"object_size_100k\":0,\"object_size_1m\":0,\"object_size_10m\":0,\"object_size_100m\":0,\"object_size_1g\":0,\"otfp\":0,\"otfp_resp_header_bytes\":0,\"otfp_resp_body_bytes\":0,\"otfp_shield_resp_header_bytes\":0,\"otfp_shield_resp_body_bytes\":0,\"otfp_manifests\":0,\"otfp_deliver_time\":0,\"otfp_shield_time\":0,\"imgopto\":0,\"imgopto_resp_header_bytes\":0,\"imgopto_resp_body_bytes\":0,\"imgopto_shield_resp_header_bytes\":0,\"imgopto_shield_resp_body_bytes\":0,\"video\":0,\"recv_sub_time\":0,\"recv_sub_count\":0,\"hash_sub_time\":0,\"hash_sub_count\":0,\"miss_sub_time\":0,\"miss_sub_count\":0,\"fetch_sub_time\":0,\"fetch_sub_count\":0,\"pass_sub_time\":0,\"pass_sub_count\":0,\"pipe_sub_time\":0,\"pipe_sub_count\":0,\"deliver_sub_time\":0,\"deliver_sub_count\":0,\"error_sub_time\":0,\"error_sub_count\":0,\"hit_sub_time\":0,\"hit_sub_count\":0,\"prehash_sub_time\":0,\"prehash_sub_count\":0,\"predeliver_sub_time\":0,\"predeliver_sub_count\":0,\"tls_handshake_sent_bytes\":0,\"hit_resp_body_bytes\":2232360,\"miss_resp_body_bytes\":2181748,\"pass_resp_body_bytes\":2242,\"log\":0,\"log_bytes\":0,\"edge_resp_header_bytes\":0,\"edge_resp_body_bytes\":0,\"origin_revalidations\":0,\"origin_fetches\":25,\"origin_fetch_header_bytes\":24821,\"origin_fetch_body_bytes\":464,\"origin_fetch_resp_header_bytes\":29434,\"origin_fetch_resp_body_bytes\":2183990,\"shield_revalidations\":0,\"shield_fetches\":0,\"shield_fetch_header_bytes\":0,\"shield_fetch_body_bytes\":0,\"shield_fetch_resp_header_bytes\":0,\"shield_fetch_resp_body_bytes\":0,\"segblock_origin_fetches\":0,\"segblock_shield_fetches\":0,\"origin_cache_fetches\":7,\"header_size\":0,\"body_size\":0,\"orig_req_header_size\":0,\"orig_req_body_size\":0,\"orig_resp_header_size\":0,\"orig_resp_body_size\":0,\"edge_requests\":0,\"errors\":0,\"compute_requests\":20,\"compute_request_time_ms\":9158.1,\"compute_ram_used\":28835840,\"compute_execution_time_ms\":114.048,\"compute_req_header_bytes\":23478,\"compute_resp_header_bytes\":10850,\"compute_resp_body_bytes\":4414108,\"compute_resp_status_2xx\":16,\"compute_resp_status_3xx\":4,\"compute_bereq_header_bytes\":33916,\"compute_bereq_body_bytes\":464,\"compute_beresp_header_bytes\":35349,\"compute_beresp_body_bytes\":4415630}}}","originalRequest":{"name":"Get stats for a service","description":"Get the stats from a service for a block of time. This lists all stats by PoP location, starting with AMS. This call requires parameters to select block of time to query. Use either a timestamp range (using start_time and end_time) or a specified month/year combo (using month and year).\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/stats/summary?end_time=1608560817&month=05&start_time=1608560817&year=2020","path":["service","SU1Z0isxPaozGVKXdv0eY","stats","summary?end_time=1608560817&month=05&start_time=1608560817&year=2020"],"host":["https://api.fastly.com"],"query":[{"key":"end_time","description":"Epoch timestamp. Limits the results returned."},{"key":"month","description":"2-digit month."},{"key":"start_time","description":"Epoch timestamp. Limits the results returned."},{"key":"year","description":"4-digit year."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}]},{"name":"Origin metrics","item":[{"name":"Origin Inspector Historical API","description":"Origin Inspector provides a JSON-formatted historical API for visibility into responses delivered from your origin servers to Fastly. The API offers a standardized set of data to report in minutely, hourly or daily granularity on every origin response, byte, and status code received by a specified service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| dimensions | object | The unique combination of dimensions associated with this timeseries. |\n| meta | object | Meta information about the scope of the query in a human readable format. |\n| msg | string | If the query was not successful, this will provide a string that explains why. |\n| status | string | Whether or not we were able to successfully execute the query. |\n| values | array | An array of values representing the metric values at each point in time.\nNote that this dataset is sparse: only the keys with non-zero values will be included in the record. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| dimensions | object | The unique combination of dimensions associated with this timeseries. |\n| values | array | An array of values representing the metric values at each point in time.\nNote that this dataset is sparse: only the keys with non-zero values will be included in the record. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| latency_0_to_1ms | integer | Number of responses from origin with latency between 0 and 1 millisecond. |\n| latency_10000_to_60000ms | integer | Number of responses from origin with latency between 10,000 and 60,000 milliseconds. |\n| latency_1000_to_5000ms | integer | Number of responses from origin with latency between 1,000 and 5,000 milliseconds. |\n| latency_100_to_250ms | integer | Number of responses from origin with latency between 100 and 250 milliseconds. |\n| latency_10_to_50ms | integer | Number of responses from origin with latency between 10 and 50 milliseconds. |\n| latency_1_to_5ms | integer | Number of responses from origin with latency between 1 and 5 milliseconds. |\n| latency_250_to_500ms | integer | Number of responses from origin with latency between 250 and 500 milliseconds. |\n| latency_5000_to_10000ms | integer | Number of responses from origin with latency between 5,000 and 10,000 milliseconds. |\n| latency_500_to_1000ms | integer | Number of responses from origin with latency between 500 and 1,000 milliseconds. |\n| latency_50_to_100ms | integer | Number of responses from origin with latency between 50 and 100 milliseconds. |\n| latency_5_to_10ms | integer | Number of responses from origin with latency between 5 and 10 milliseconds. |\n| latency_60000ms | integer | Number of responses from origin with latency of 60,000 milliseconds and above. |\n| resp_body_bytes | integer | Number of body bytes from origin. |\n| resp_header_bytes | integer | Number of header bytes from origin. |\n| responses | integer | Number of responses from origin. |\n| status_1xx | integer | Number of 1xx \"Informational\" category status codes delivered from origin. |\n| status_200 | integer | Number of responses received with status code 200 (Success) from origin. |\n| status_204 | integer | Number of responses received with status code 204 (No Content) from origin. |\n| status_206 | integer | Number of responses received with status code 206 (Partial Content) from origin. |\n| status_2xx | integer | Number of 2xx \"Success\" status codes delivered from origin. |\n| status_301 | integer | Number of responses received with status code 301 (Moved Permanently) from origin. |\n| status_302 | integer | Number of responses received with status code 302 (Found) from origin. |\n| status_304 | integer | Number of responses received with status code 304 (Not Modified) from origin. |\n| status_3xx | integer | Number of 3xx \"Redirection\" codes delivered from origin. |\n| status_400 | integer | Number of responses received with status code 400 (Bad Request) from origin. |\n| status_401 | integer | Number of responses received with status code 401 (Unauthorized) from origin. |\n| status_403 | integer | Number of responses received with status code 403 (Forbidden) from origin. |\n| status_404 | integer | Number of responses received with status code 404 (Not Found) from origin. |\n| status_416 | integer | Number of responses received with status code 416 (Range Not Satisfiable) from origin. |\n| status_429 | integer | Number of responses received with status code 429 (Too Many Requests) from origin. |\n| status_4xx | integer | Number of 4xx \"Client Error\" codes delivered from origin. |\n| status_500 | integer | Number of responses received with status code 500 (Internal Server Error) from origin. |\n| status_501 | integer | Number of responses received with status code 501 (Not Implemented) from origin. |\n| status_502 | integer | Number of responses received with status code 502 (Bad Gateway) from origin. |\n| status_503 | integer | Number of responses received with status code 503 (Service Unavailable) from origin. |\n| status_504 | integer | Number of responses received with status code 504 (Gateway Timeout) from origin. |\n| status_505 | integer | Number of responses received with status code 505 (HTTP Version Not Supported) from origin. |\n| status_5xx | integer | Number of 5xx \"Server Error\" codes delivered from origin. |","item":[{"name":"Get historical origin data for a service","request":{"name":"Get historical origin data for a service","description":"Fetches historical origin metrics for a given Fastly service, optionally filtering and grouping the results by origin host, region, or POP.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/metrics/origins/services/{{service_id}}","path":["metrics","origins","services","{{service_id}}"],"host":["{{fastly_url}}"],"query":[{"key":"cursor","description":"Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty."},{"key":"datacenter","description":"Limit query to one or more specific POPs. Values should be comma-separated."},{"key":"downsample","description":"Duration of sample windows."},{"key":"end","description":"A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided downsample value."},{"key":"group_by","description":"Dimensions to return in the query. Multiple dimensions may be separated by commas.\nFor example, group_by=domain will return one timeseries for every domain, as a total across all datacenters (POPs)."},{"key":"host","description":"Limit query to one or more specific origin hosts. Values should be comma-separated."},{"key":"limit","description":"Number of results per page. The maximum is 200."},{"key":"metric","description":"The metric to retrieve. Up to ten comma-separated metrics are accepted."},{"key":"region","description":"Limit query to one or more specific geographic regions. Values should be comma-separated."},{"key":"start","description":"A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided downsample value."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"dimensions\":{\"host\":\"origin_1\",\"region\":\"usa\",\"datacenter\":\"SJC\"},\"values\":[{\"timestamp\":1627772400,\"resp_body_bytes\":552256,\"status_2xx\":1},{\"timestamp\":1627776000,\"resp_body_bytes\":12323,\"status_2xx\":34}]},{\"dimensions\":{\"host\":\"origin_2\",\"region\":\"usa\",\"datacenter\":\"STP\"},\"values\":[{\"timestamp\":1627772400,\"resp_body_bytes\":221,\"status_2xx\":1},{\"timestamp\":1627776000,\"resp_body_bytes\":234,\"status_2xx\":34}]}],\"meta\":{\"start\":\"2021-08-01T00:00:00Z\",\"end\":\"2020-08-02T00:00:00Z\",\"downsample\":\"hour\",\"metric\":\"resp_body_bytes,status_2xx\",\"limit\":100,\"next_cursor\":\"VTBwRENqVTJXVmszUz\",\"sort\":\"host,region,datacenter\",\"group_by\":\"none\",\"filters\":{}},\"status\":\"success\"}","originalRequest":{"name":"Get historical origin data for a service","description":"Fetches historical origin metrics for a given Fastly service, optionally filtering and grouping the results by origin host, region, or POP.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/metrics/origins/services/SU1Z0isxPaozGVKXdv0eY?datacenter=SJC%2CSTP&downsample=hour&end=2020-08-02T00%3A00%3A00.000Z&group_by=domain&host=origin_1%2Corigin_2&metric=resp_body_bytes%2Cstatus_2xx&region=usa&start=2021-08-01T00%3A00%3A00.000Z","path":["metrics","origins","services","SU1Z0isxPaozGVKXdv0eY?datacenter=SJC%2CSTP&downsample=hour&end=2020-08-02T00%3A00%3A00.000Z&group_by=domain&host=origin_1%2Corigin_2&metric=resp_body_bytes%2Cstatus_2xx&region=usa&start=2021-08-01T00%3A00%3A00.000Z"],"host":["https://api.fastly.com"],"query":[{"key":"cursor","description":"Cursor value from a previous response to retrieve the next page. To request the first page, this should be empty."},{"key":"datacenter","description":"Limit query to one or more specific POPs. Values should be comma-separated."},{"key":"downsample","description":"Duration of sample windows."},{"key":"end","description":"A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the exclusive end of the query time range. If not provided, a default is chosen based on the provided downsample value."},{"key":"group_by","description":"Dimensions to return in the query. Multiple dimensions may be separated by commas.\nFor example, group_by=domain will return one timeseries for every domain, as a total across all datacenters (POPs)."},{"key":"host","description":"Limit query to one or more specific origin hosts. Values should be comma-separated."},{"key":"limit","description":"Number of results per page. The maximum is 200."},{"key":"metric","description":"The metric to retrieve. Up to ten comma-separated metrics are accepted."},{"key":"region","description":"Limit query to one or more specific geographic regions. Values should be comma-separated."},{"key":"start","description":"A valid ISO-8601-formatted date and time, or UNIX timestamp, indicating the inclusive start of the query time range. If not provided, a default is chosen based on the provided downsample value."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Origin Inspector Real-time API","description":"Origin Inspector offers a real-time JSON-formatted data stream providing visibility into responses delivered from your origin servers to Fastly. The API offers a standardized set of data to report in real-time every origin response, byte, and status code received by a specified service in one-second periods up to the last complete second.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| AggregateDelay | integer | Offset of entry timestamps from the current time due to processing time. |\n| Data | array | A list of report entries, each representing one second of time. |\n| Timestamp | integer | Value to use for subsequent requests. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| aggregated | object | Groups measurements by backend name. |\n| datacenter | object | Groups measurements by POP, then backend name. See the POPs API for details about POP identifiers. |\n| recorded | integer | The Unix timestamp at which this record's data was generated. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| latency_0_to_1ms | integer | Number of responses from origin with latency between 0 and 1 millisecond. |\n| latency_10000_to_60000ms | integer | Number of responses from origin with latency between 10,000 and 60,000 milliseconds. |\n| latency_1000_to_5000ms | integer | Number of responses from origin with latency between 1,000 and 5,000 milliseconds. |\n| latency_100_to_250ms | integer | Number of responses from origin with latency between 100 and 250 milliseconds. |\n| latency_10_to_50ms | integer | Number of responses from origin with latency between 10 and 50 milliseconds. |\n| latency_1_to_5ms | integer | Number of responses from origin with latency between 1 and 5 milliseconds. |\n| latency_250_to_500ms | integer | Number of responses from origin with latency between 250 and 500 milliseconds. |\n| latency_5000_to_10000ms | integer | Number of responses from origin with latency between 5,000 and 10,000 milliseconds. |\n| latency_500_to_1000ms | integer | Number of responses from origin with latency between 500 and 1,000 milliseconds. |\n| latency_50_to_100ms | integer | Number of responses from origin with latency between 50 and 100 milliseconds. |\n| latency_5_to_10ms | integer | Number of responses from origin with latency between 5 and 10 milliseconds. |\n| latency_60000ms | integer | Number of responses from origin with latency of 60,000 milliseconds and above. |\n| resp_body_bytes | integer | Number of body bytes from origin. |\n| resp_header_bytes | integer | Number of header bytes from origin. |\n| responses | integer | Number of responses from origin. |\n| status_1xx | integer | Number of 1xx \"Informational\" category status codes delivered from origin. |\n| status_200 | integer | Number of responses received with status code 200 (Success) from origin. |\n| status_204 | integer | Number of responses received with status code 204 (No Content) from origin. |\n| status_206 | integer | Number of responses received with status code 206 (Partial Content) from origin. |\n| status_2xx | integer | Number of 2xx \"Success\" status codes delivered from origin. |\n| status_301 | integer | Number of responses received with status code 301 (Moved Permanently) from origin. |\n| status_302 | integer | Number of responses received with status code 302 (Found) from origin. |\n| status_304 | integer | Number of responses received with status code 304 (Not Modified) from origin. |\n| status_3xx | integer | Number of 3xx \"Redirection\" codes delivered from origin. |\n| status_400 | integer | Number of responses received with status code 400 (Bad Request) from origin. |\n| status_401 | integer | Number of responses received with status code 401 (Unauthorized) from origin. |\n| status_403 | integer | Number of responses received with status code 403 (Forbidden) from origin. |\n| status_404 | integer | Number of responses received with status code 404 (Not Found) from origin. |\n| status_416 | integer | Number of responses received with status code 416 (Range Not Satisfiable) from origin. |\n| status_429 | integer | Number of responses received with status code 429 (Too Many Requests) from origin. |\n| status_4xx | integer | Number of 4xx \"Client Error\" codes delivered from origin. |\n| status_500 | integer | Number of responses received with status code 500 (Internal Server Error) from origin. |\n| status_501 | integer | Number of responses received with status code 501 (Not Implemented) from origin. |\n| status_502 | integer | Number of responses received with status code 502 (Bad Gateway) from origin. |\n| status_503 | integer | Number of responses received with status code 503 (Service Unavailable) from origin. |\n| status_504 | integer | Number of responses received with status code 504 (Gateway Timeout) from origin. |\n| status_505 | integer | Number of responses received with status code 505 (HTTP Version Not Supported) from origin. |\n| status_5xx | integer | Number of 5xx \"Server Error\" codes delivered from origin. |","item":[{"name":"Get real-time origin data from specific time","request":{"name":"Get real-time origin data from specific time","description":"Get real-time origin data for the specified reporting period. Specify 0 to get a single entry for the last complete second. The Timestamp field included in the response provides the time index of the latest entry in the dataset and can be provided as the start_timestamp of the next request for a seamless continuation of the dataset from one request to the next.\nDue to processing latency, the earliest entry in the response dataset may be earlier than start_timestamp by the value of AggregateDelay.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/v1/origins/{{service_id}}/ts/{{start_timestamp}}","path":["v1","origins","{{service_id}}","ts","{{start_timestamp}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"Data\":[{\"datacenter\":{\"STP\":{\"origin_1\":{\"responses\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}}},\"aggregated\":{\"origin_1\":{\"responses\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}},\"recorded\":1589198016}],\"Timestamp\":1589198025,\"AggregateDelay\":9}","originalRequest":{"name":"Get real-time origin data from specific time","description":"Get real-time origin data for the specified reporting period. Specify 0 to get a single entry for the last complete second. The Timestamp field included in the response provides the time index of the latest entry in the dataset and can be provided as the start_timestamp of the next request for a seamless continuation of the dataset from one request to the next.\nDue to processing latency, the earliest entry in the response dataset may be earlier than start_timestamp by the value of AggregateDelay.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/v1/origins/SU1Z0isxPaozGVKXdv0eY/ts/1608560817","path":["v1","origins","SU1Z0isxPaozGVKXdv0eY","ts","1608560817"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get real-time origin data for the last 120 seconds","request":{"name":"Get real-time origin data for the last 120 seconds","description":"Get data for the 120 seconds preceding the latest timestamp available for a service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/v1/origins/{{service_id}}/ts/h","path":["v1","origins","{{service_id}}","ts","h"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"Data\":[{\"datacenter\":{\"STP\":{\"origin_1\":{\"responses\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}}},\"aggregated\":{\"origin_1\":{\"responses\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}},\"recorded\":1589198016}],\"Timestamp\":1589198025,\"AggregateDelay\":9}","originalRequest":{"name":"Get real-time origin data for the last 120 seconds","description":"Get data for the 120 seconds preceding the latest timestamp available for a service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/v1/origins/SU1Z0isxPaozGVKXdv0eY/ts/h","path":["v1","origins","SU1Z0isxPaozGVKXdv0eY","ts","h"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get a limited number of real-time origin data entries","request":{"name":"Get a limited number of real-time origin data entries","description":"Get data for the max_entries seconds preceding the latest timestamp available for a service, up to a maximum of 120 entries.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/v1/origins/{{service_id}}/ts/h/limit/{{max_entries}}","path":["v1","origins","{{service_id}}","ts","h","limit","{{max_entries}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"Data\":[{\"datacenter\":{\"STP\":{\"origin_1\":{\"responses\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}}},\"aggregated\":{\"origin_1\":{\"responses\":5,\"resp_header_bytes\":1200,\"resp_body_bytes\":1850,\"status_4xx\":5,\"status_403\":5}},\"recorded\":1589198016}],\"Timestamp\":1589198025,\"AggregateDelay\":9}","originalRequest":{"name":"Get a limited number of real-time origin data entries","description":"Get data for the max_entries seconds preceding the latest timestamp available for a service, up to a maximum of 120 entries.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/v1/origins/SU1Z0isxPaozGVKXdv0eY/ts/h/limit/1","path":["v1","origins","SU1Z0isxPaozGVKXdv0eY","ts","h","limit","1"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"rt.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}]},{"name":"Services","item":[{"name":"Backend","description":"A backend (also sometimes called an origin server) is a server identified by IP address or hostname, from which Fastly will fetch your content. There can be multiple backends attached to a service, but each backend is specific to one service. By default, the first backend added to a service configuration will be used for all requests (provided it meets any conditions attached to it). If multiple backends are defined for a service, the first one that has no attached conditions, or whose condition is satisfied for the current request, will be used, unless that behavior is modified using the auto_loadbalance field described below.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| address | string | A hostname, IPv4, or IPv6 address for the backend. This is the preferred way to specify the location of your backend. |\n| auto_loadbalance | boolean | Whether or not this backend should be automatically load balanced. If true, all backends with this setting that don't have a request_condition will be selected based on their weight. |\n| between_bytes_timeout | integer | Maximum duration in milliseconds that Fastly will wait while receiving no data on a download from a backend. If exceeded, the response received so far will be considered complete and the fetch will end. May be set at runtime using bereq.between_bytes_timeout. |\n| client_cert | string | Unused. |\n| comment | string | A freeform descriptive note. |\n| connect_timeout | integer | Maximum duration in milliseconds to wait for a connection to this backend to be established. If exceeded, the connection is aborted and a synthethic 503 response will be presented instead. May be set at runtime using bereq.connect_timeout. |\n| first_byte_timeout | integer | Maximum duration in milliseconds to wait for the server response to begin after a TCP connection is established and the request has been sent. If exceeded, the connection is aborted and a synthethic 503 response will be presented instead. May be set at runtime using bereq.first_byte_timeout. |\n| healthcheck | string | The name of the healthcheck to use with this backend. |\n| hostname | string | The hostname of the backend. May be used as an alternative to address to set the backend location. |\n| ipv4 | string | IPv4 address of the backend. May be used as an alternative to address to set the backend location. |\n| ipv6 | string | IPv6 address of the backend. May be used as an alternative to address to set the backend location. |\n| max_conn | integer | Maximum number of concurrent connections this backend will accept. |\n| max_tls_version | string | Maximum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic 503 error response will be generated. |\n| min_tls_version | string | Minimum allowed TLS version on SSL connections to this backend. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic 503 error response will be generated. |\n| name | string | The name of the backend. |\n| override_host | string | If set, will replace the client-supplied HTTP Host header on connections to this backend. Applied after VCL has been processed, so this setting will take precedence over changing bereq.http.Host in VCL. |\n| port | integer | Port on which the backend server is listening for connections from Fastly. Setting port to 80 or 443 will also set use_ssl automatically (to false and true respectively), unless explicitly overridden by setting use_ssl in the same request. |\n| request_condition | string | Name of a Condition, which if satisfied, will select this backend during a request. If set, will override any auto_loadbalance setting. By default, the first backend added to a service is selected for all requests. |\n| shield | string | Identifier of the POP to use as a shield. |\n| ssl_ca_cert | string | CA certificate attached to origin. |\n| ssl_cert_hostname | string | Overrides ssl_hostname, but only for cert verification. Does not affect SNI at all. |\n| ssl_check_cert | boolean | Be strict on checking SSL certs. |\n| ssl_ciphers | string | List of OpenSSL ciphers to support for connections to this origin. If your backend server is not able to negotiate a connection meeting this constraint, a synthetic 503 error response will be generated. |\n| ssl_client_cert | string | Client certificate attached to origin. |\n| ssl_client_key | string | Client key attached to origin. |\n| ssl_hostname | string | Use ssl_cert_hostname and ssl_sni_hostname to configure certificate validation. |\n| ssl_sni_hostname | string | Overrides ssl_hostname, but only for SNI in the handshake. Does not affect cert validation at all. |\n| use_ssl | boolean | Whether or not to require TLS for connections to this backend. |\n| weight | integer | Weight used to load balance this backend against others. May be any positive integer. If auto_loadbalance is true, the chance of this backend being selected is equal to its own weight over the sum of all weights for backends that have auto_loadbalance set to true. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| locked | boolean | Indicates whether the version of the service this backend is attached to accepts edits. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List backends","request":{"name":"List backends","description":"List all backends for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/backend","path":["service","{{service_id}}","version","{{version_id}}","backend"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"address\":\"127.0.0.1\",\"auto_loadbalance\":false,\"between_bytes_timeout\":10000,\"client_cert\":null,\"comment\":\"\",\"connect_timeout\":1000,\"first_byte_timeout\":15000,\"healthcheck\":null,\"hostname\":null,\"ipv4\":\"127.0.0.1\",\"ipv6\":null,\"locked\":true,\"max_conn\":200,\"max_tls_version\":null,\"min_tls_version\":null,\"name\":\"test-backend\",\"port\":80,\"request_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"shield\":null,\"override_host\":null,\"ssl_ca_cert\":null,\"ssl_cert_hostname\":null,\"ssl_check_cert\":true,\"ssl_ciphers\":null,\"ssl_client_cert\":null,\"ssl_client_key\":null,\"ssl_hostname\":null,\"ssl_sni_hostname\":null,\"use_ssl\":false,\"version\":1,\"weight\":100}]","originalRequest":{"name":"List backends","description":"List all backends for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/backend","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","backend"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a backend","request":{"name":"Create a backend","description":"Create a backend for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/backend","path":["service","{{service_id}}","version","{{version_id}}","backend"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"address\":\"127.0.0.1\",\"auto_loadbalance\":false,\"between_bytes_timeout\":10000,\"client_cert\":null,\"comment\":\"\",\"connect_timeout\":1000,\"first_byte_timeout\":15000,\"healthcheck\":null,\"hostname\":null,\"ipv4\":\"127.0.0.1\",\"ipv6\":null,\"locked\":true,\"max_conn\":200,\"max_tls_version\":null,\"min_tls_version\":null,\"name\":\"test-backend\",\"port\":80,\"request_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"shield\":null,\"override_host\":null,\"ssl_ca_cert\":null,\"ssl_cert_hostname\":null,\"ssl_check_cert\":true,\"ssl_ciphers\":null,\"ssl_client_cert\":null,\"ssl_client_key\":null,\"ssl_hostname\":null,\"ssl_sni_hostname\":null,\"use_ssl\":false,\"version\":1,\"weight\":100}","originalRequest":{"name":"Create a backend","description":"Create a backend for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/backend","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","backend"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Describe a backend","request":{"name":"Describe a backend","description":"Get the backend for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/backend/{{backend_name}}","path":["service","{{service_id}}","version","{{version_id}}","backend","{{backend_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"address\":\"127.0.0.1\",\"auto_loadbalance\":false,\"between_bytes_timeout\":10000,\"client_cert\":null,\"comment\":\"\",\"connect_timeout\":1000,\"first_byte_timeout\":15000,\"healthcheck\":null,\"hostname\":null,\"ipv4\":\"127.0.0.1\",\"ipv6\":null,\"locked\":true,\"max_conn\":200,\"max_tls_version\":null,\"min_tls_version\":null,\"name\":\"test-backend\",\"port\":80,\"request_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"shield\":null,\"override_host\":null,\"ssl_ca_cert\":null,\"ssl_cert_hostname\":null,\"ssl_check_cert\":true,\"ssl_ciphers\":null,\"ssl_client_cert\":null,\"ssl_client_key\":null,\"ssl_hostname\":null,\"ssl_sni_hostname\":null,\"use_ssl\":false,\"version\":1,\"weight\":100}","originalRequest":{"name":"Describe a backend","description":"Get the backend for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/backend/test-backend","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","backend","test-backend"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a backend","request":{"name":"Update a backend","description":"Update the backend for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/backend/{{backend_name}}","path":["service","{{service_id}}","version","{{version_id}}","backend","{{backend_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"address\":\"127.0.0.1\",\"auto_loadbalance\":false,\"between_bytes_timeout\":10000,\"client_cert\":null,\"comment\":\"\",\"connect_timeout\":1000,\"first_byte_timeout\":15000,\"healthcheck\":null,\"hostname\":null,\"ipv4\":\"127.0.0.1\",\"ipv6\":null,\"locked\":true,\"max_conn\":200,\"max_tls_version\":null,\"min_tls_version\":null,\"name\":\"updated-test-backend\",\"port\":80,\"request_condition\":\"\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"shield\":null,\"override_host\":null,\"ssl_ca_cert\":null,\"ssl_cert_hostname\":null,\"ssl_check_cert\":true,\"ssl_ciphers\":null,\"ssl_client_cert\":null,\"ssl_client_key\":null,\"ssl_hostname\":null,\"ssl_sni_hostname\":null,\"use_ssl\":false,\"version\":1,\"weight\":100}","originalRequest":{"name":"Update a backend","description":"Update the backend for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/backend/test-backend","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","backend","test-backend"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a backend","request":{"name":"Delete a backend","description":"Delete the backend for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/backend/{{backend_name}}","path":["service","{{service_id}}","version","{{version_id}}","backend","{{backend_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a backend","description":"Delete the backend for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/backend/test-backend","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","backend","test-backend"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Domain","description":"A domain represents the domain name through which visitors will retrieve content. There can be multiple domains for a service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| comment | string | A freeform descriptive note. |\n| name | string | The name of the domain or domains associated with this service. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"Validate DNS configuration for all domains on a service","request":{"name":"Validate DNS configuration for all domains on a service","description":"Checks the status of all domains' DNS records for a Service Version. Returns an array of 3 items for each domain; the first is the details for the domain, the second is the current CNAME of the domain, and the third is a boolean indicating whether or not it has been properly setup to use Fastly.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/domain/check_all","path":["service","{{service_id}}","version","{{version_id}}","domain","check_all"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[[{\"comment\":\"\",\"name\":\"www.example.com\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"created_at\":\"2020-03-15T20:10:09.000Z\",\"updated_at\":\"2020-03-15T20:10:09.000Z\",\"deleted_at\":null},\"global.prod.fastly.net.\",true]]","originalRequest":{"name":"Validate DNS configuration for all domains on a service","description":"Checks the status of all domains' DNS records for a Service Version. Returns an array of 3 items for each domain; the first is the details for the domain, the second is the current CNAME of the domain, and the third is a boolean indicating whether or not it has been properly setup to use Fastly.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/domain/check_all","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","domain","check_all"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Validate DNS configuration for a single domain on a service","request":{"name":"Validate DNS configuration for a single domain on a service","description":"Checks the status of a specific domain's DNS record for a Service Version. Returns an array in the same format as domain/check_all.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/domain/{{domain_name}}/check","path":["service","{{service_id}}","version","{{version_id}}","domain","{{domain_name}}","check"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"comment\":\"\",\"name\":\"www.example.com\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"created_at\":\"2020-03-15T20:10:09.000Z\",\"updated_at\":\"2020-03-15T20:10:09.000Z\",\"deleted_at\":null},\"global.prod.fastly.net.\",true]","originalRequest":{"name":"Validate DNS configuration for a single domain on a service","description":"Checks the status of a specific domain's DNS record for a Service Version. Returns an array in the same format as domain/check_all.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/domain/www.example.com/check","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","domain","www.example.com","check"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"List domains","request":{"name":"List domains","description":"List all the domains for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/domain","path":["service","{{service_id}}","version","{{version_id}}","domain"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"comment\":\"\",\"name\":\"www.example.com\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"created_at\":\"2020-03-15T20:10:09.000Z\",\"updated_at\":\"2020-03-15T20:10:09.000Z\",\"deleted_at\":null}]","originalRequest":{"name":"List domains","description":"List all the domains for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/domain","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","domain"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Add a domain name to a service","request":{"name":"Add a domain name to a service","description":"Create a domain for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/domain","path":["service","{{service_id}}","version","{{version_id}}","domain"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"comment\":\"\",\"name\":\"www.example.com\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"created_at\":\"2020-03-15T20:10:09.000Z\",\"updated_at\":\"2020-03-15T20:10:09.000Z\",\"deleted_at\":null}","originalRequest":{"name":"Add a domain name to a service","description":"Create a domain for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/domain","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","domain"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Describe a domain","request":{"name":"Describe a domain","description":"Get the domain for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/domain/{{domain_name}}","path":["service","{{service_id}}","version","{{version_id}}","domain","{{domain_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"comment\":\"\",\"name\":\"www.example.com\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"created_at\":\"2020-03-15T20:10:09.000Z\",\"updated_at\":\"2020-03-15T20:10:09.000Z\",\"deleted_at\":null}","originalRequest":{"name":"Describe a domain","description":"Get the domain for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/domain/www.example.com","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","domain","www.example.com"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a domain","request":{"name":"Update a domain","description":"Update the domain for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/domain/{{domain_name}}","path":["service","{{service_id}}","version","{{version_id}}","domain","{{domain_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"comment\":\"\",\"name\":\"www.updated-example.com\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"created_at\":\"2020-03-15T20:10:09.000Z\",\"updated_at\":\"2020-03-15T20:10:09.000Z\",\"deleted_at\":null}","originalRequest":{"name":"Update a domain","description":"Update the domain for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/domain/www.example.com","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","domain","www.example.com"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Remove a domain from a service","request":{"name":"Remove a domain from a service","description":"Delete the domain for a particular service and versions.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/domain/{{domain_name}}","path":["service","{{service_id}}","version","{{version_id}}","domain","{{domain_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Remove a domain from a service","description":"Delete the domain for a particular service and versions.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/domain/www.example.com","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","domain","www.example.com"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Healthcheck","description":"Healthchecks are used to customize the way Fastly checks on your Backends. If an origin server is marked unhealthy due to health checks, Fastly will stop attempting to send requests to it. If all origin servers are marked unhealthy, Fastly will attempt to serve stale. If no stale object is available, a 503 will be returned to the client.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| check_interval | integer | How often to run the healthcheck in milliseconds. |\n| comment | string | A freeform descriptive note. |\n| expected_response | integer | The status code expected from the host. |\n| host | string | Which host to check. |\n| http_version | string | Whether to use version 1.0 or 1.1 HTTP. |\n| initial | integer | When loading a config, the initial number of probes to be seen as OK. |\n| method | string | Which HTTP method to use. |\n| name | string | The name of the healthcheck. |\n| path | string | The path to check. |\n| threshold | integer | How many healthchecks must succeed to be considered healthy. |\n| timeout | integer | Timeout in milliseconds. |\n| window | integer | The number of most recent healthcheck queries to keep for this healthcheck. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |","item":[{"name":"List healthchecks","request":{"name":"List healthchecks","description":"List all of the healthchecks for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/healthcheck","path":["service","{{service_id}}","version","{{version_id}}","healthcheck"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"check_interval\":5000,\"comment\":\"\",\"expected_response\":200,\"host\":\"example.com\",\"http_version\":\"1.1\",\"initial\":2,\"method\":\"HEAD\",\"name\":\"test-healthcheck\",\"path\":\"/test.txt\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"threshold\":3,\"timeout\":500,\"version\":1,\"window\":5}]","originalRequest":{"name":"List healthchecks","description":"List all of the healthchecks for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/healthcheck","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","healthcheck"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a healthcheck","request":{"name":"Create a healthcheck","description":"Create a healthcheck for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/healthcheck","path":["service","{{service_id}}","version","{{version_id}}","healthcheck"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"check_interval\":5000,\"comment\":\"\",\"expected_response\":200,\"host\":\"example.com\",\"http_version\":\"1.1\",\"initial\":2,\"method\":\"HEAD\",\"name\":\"test-healthcheck\",\"path\":\"/test.txt\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"threshold\":3,\"timeout\":500,\"version\":1,\"window\":5}","originalRequest":{"name":"Create a healthcheck","description":"Create a healthcheck for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/healthcheck","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","healthcheck"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get a healthcheck","request":{"name":"Get a healthcheck","description":"Get the healthcheck for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/healthcheck/{{healthcheck_name}}","path":["service","{{service_id}}","version","{{version_id}}","healthcheck","{{healthcheck_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"check_interval\":5000,\"comment\":\"\",\"expected_response\":200,\"host\":\"example.com\",\"http_version\":\"1.1\",\"initial\":2,\"method\":\"HEAD\",\"name\":\"test-healthcheck\",\"path\":\"/test.txt\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"threshold\":3,\"timeout\":500,\"version\":1,\"window\":5}","originalRequest":{"name":"Get a healthcheck","description":"Get the healthcheck for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/healthcheck/test-healthcheck","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","healthcheck","test-healthcheck"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a healthcheck","request":{"name":"Update a healthcheck","description":"Update the healthcheck for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/healthcheck/{{healthcheck_name}}","path":["service","{{service_id}}","version","{{version_id}}","healthcheck","{{healthcheck_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"check_interval\":5000,\"comment\":\"\",\"expected_response\":200,\"host\":\"example.com\",\"http_version\":\"1.1\",\"initial\":2,\"method\":\"HEAD\",\"name\":\"test-healthcheck\",\"path\":\"/test.txt\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"threshold\":3,\"timeout\":500,\"version\":1,\"window\":5}","originalRequest":{"name":"Update a healthcheck","description":"Update the healthcheck for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/healthcheck/test-healthcheck","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","healthcheck","test-healthcheck"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a healthcheck","request":{"name":"Delete a healthcheck","description":"Delete the healthcheck for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/healthcheck/{{healthcheck_name}}","path":["service","{{service_id}}","version","{{version_id}}","healthcheck","{{healthcheck_name}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a healthcheck","description":"Delete the healthcheck for a particular service and version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/healthcheck/test-healthcheck","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","healthcheck","test-healthcheck"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Package","description":"Compute@Edge is a computation platform capable of running custom binary packages that you compile on your own systems and upload to Fastly. These packages are associated with a service version and are deployed to Fastly's edge network.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| metadata | object | Package metadata that has been extracted from the uploaded package. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying the package. |\n| service_id | string | Alphanumeric string identifying the service. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| version | integer | Integer identifying a service version. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| authors | array | A list of package authors' email addresses. |\n| description | string | Description of the Compute@Edge package. |\n| hashsum | string | Hash of the Compute@Edge package. |\n| language | string | The language of the Compute@Edge package. |\n| name | string | Name of the Compute@Edge package. |\n| size | integer | Size of the Compute@Edge package in bytes. |\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| package | string | The content of the Wasm binary package. |","item":[{"name":"Get details of the service's Compute@Edge package","request":{"name":"Get details of the service's Compute@Edge package","description":"List detailed information about the Compute@Edge package for the specified service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/package","path":["service","{{service_id}}","version","{{version_id}}","package"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"id\":\"2jejPzXC4GYh189GU3CCA6\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"metadata\":{\"name\":\"some-package-name\",\"description\":\"Some description\",\"authors\":[\"<support@fastly.com>\"],\"language\":\"rust\",\"size\":1234567,\"created_at\":\"2020-06-24T22:54:28.000Z\",\"updated_at\":\"2020-06-24T22:54:28.000Z\",\"deleted_at\":null}}","originalRequest":{"name":"Get details of the service's Compute@Edge package","description":"List detailed information about the Compute@Edge package for the specified service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/package","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","package"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Upload a Compute@Edge package","request":{"name":"Upload a Compute@Edge package","description":"Upload a Compute@Edge package associated with the specified service version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/package","path":["service","{{service_id}}","version","{{version_id}}","package"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"multipart/form-data; boundary=\"boundary\""},{"key":"Accept","value":"application/json"},{"key":"expect","value":"100-continue"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"package\":\"(binary data ...)\"}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"id\":\"2jejPzXC4GYh189GU3CCA6\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"metadata\":{\"name\":\"some-package-name\",\"description\":\"Some description\",\"authors\":[\"<support@fastly.com>\"],\"language\":\"rust\",\"size\":1234567,\"created_at\":\"2020-06-24T22:54:28.000Z\",\"updated_at\":\"2020-06-24T22:54:28.000Z\",\"deleted_at\":null}}","originalRequest":{"name":"Upload a Compute@Edge package","description":"Upload a Compute@Edge package associated with the specified service version.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/package","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","package"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"multipart/form-data; boundary=\"boundary\""},{"key":"Accept","value":"application/json"},{"key":"expect","value":"100-continue"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"package\":\"(binary data ...)\"}"}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Service","description":"A Service represents the configuration for a website, app, API, or anything else to be served through Fastly. A Service can have many Versions, through which Backends, Domains, and more can be configured.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| comment | string | A freeform descriptive note. |\n| customer_id | string | Alphanumeric string identifying the customer. |\n| name | string | The name of the service. |\n| type | string | The type of this service. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying the service. |\n| paused | boolean | Whether the service is paused. Services are paused due to a lack of traffic for an extended period of time. Services are resumed either when a draft version is activated or a locked version is cloned and reactivated. |\n| publish_key | string | Unused at this time. |\n| updated_at | string | Date and time in ISO 8601 format. |\n| versions | array | A list of versions associated with the service. |\n| active | boolean | Whether this is the active version or not. |\n| backends | array | List of backends associated to this service. |\n| cache_settings | array | List of cache settings associated to this service. |\n| conditions | array | List of conditions associated to this service. |\n| deployed | boolean | Unused at this time. |\n| directors | array | List of directors associated to this service. |\n| domains | array | List of domains associated to this service. |\n| gzips | array | List of gzip rules associated to this service. |\n| headers | array | List of headers associated to this service. |\n| healthchecks | array | List of healthchecks associated to this service. |\n| locked | boolean | Whether this version is locked or not. Objects can not be added or edited on locked versions. |\n| number | integer | The number of this version. |\n| request_settings | array | List of request settings for this service. |\n| response_objects | array | List of response objects for this service. |\n| service_id | string | Alphanumeric string identifying the service. |\n| settings | object | List of default settings for this service. |\n| snippets | array | List of VCL snippets for this service. |\n| staging | boolean | Unused at this time. |\n| testing | boolean | Unused at this time. |\n| vcls | array | List of VCL files for this service. |\n| wordpress | array | A list of Wordpress rules with this service. |","item":[{"name":"List services","request":{"name":"List services","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/services/service/#list-services)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service","path":["service"],"host":["{{fastly_url}}"],"query":[{"key":"direction","description":"Direction in which to sort results."},{"key":"page","description":"Current page."},{"key":"per_page","description":"Number of records per page."},{"key":"sort","description":"Field on which to sort."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"comment\":\"\",\"created_at\":\"2020-04-27T19:40:49.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"test-service\",\"version\":1,\"paused\":false,\"type\":\"vcl\",\"updated_at\":\"2020-04-27T19:40:49.000Z\",\"versions\":[{\"created_at\":\"2020-04-09T18:14:30.000Z\",\"updated_at\":\"2020-04-09T18:14:30.000Z\",\"deleted_at\":null,\"active\":true,\"comment\":\"\",\"deployed\":true,\"locked\":false,\"number\":1,\"staging\":false,\"testing\":false,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\"}]}]","originalRequest":{"name":"List services","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/services/service/#list-services)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service?direction=ascend&page=1&per_page=20&sort=created","path":["service?direction=ascend&page=1&per_page=20&sort=created"],"host":["https://api.fastly.com"],"query":[{"key":"direction","description":"Direction in which to sort results."},{"key":"page","description":"Current page."},{"key":"per_page","description":"Number of records per page."},{"key":"sort","description":"Field on which to sort."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a service","request":{"name":"Create a service","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/services/service/#create-service)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/service","path":["service"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"comment\":\"\",\"created_at\":\"2020-04-27T19:40:49.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"test-service\",\"publish_key\":\"\",\"paused\":false,\"type\":\"vcl\",\"updated_at\":\"2020-04-27T19:40:49.000Z\",\"versions\":[{\"created_at\":\"2020-04-09T18:14:30.000Z\",\"updated_at\":\"2020-04-09T18:14:30.000Z\",\"deleted_at\":null,\"active\":true,\"comment\":\"\",\"deployed\":true,\"locked\":false,\"number\":1,\"staging\":false,\"testing\":false,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\"}]}","originalRequest":{"name":"Create a service","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/services/service/#create-service)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/service","path":["service"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Get service details","request":{"name":"Get service details","description":"List detailed information on a specified service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/details","path":["service","{{service_id}}","details"],"host":["{{fastly_url}}"],"query":[{"key":"version","description":"Number identifying a version of the service."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"comment\":\"\",\"created_at\":\"2020-04-27T19:40:49.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"test-service\",\"publish_key\":\"\",\"paused\":false,\"type\":\"vcl\",\"updated_at\":\"2020-04-27T19:40:49.000Z\",\"versions\":[{\"created_at\":\"2020-04-09T18:14:30.000Z\",\"updated_at\":\"2020-04-09T18:14:30.000Z\",\"deleted_at\":null,\"active\":false,\"comment\":\"\",\"deployed\":true,\"locked\":false,\"number\":1,\"staging\":false,\"testing\":false,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\"}],\"version\":{\"active\":false,\"backends\":[],\"cache_settings\":[],\"comment\":\"\",\"conditions\":[],\"deployed\":true,\"dictionaries\":[],\"directors\":[],\"domains\":[],\"gzips\":[],\"headers\":[],\"healthchecks\":[],\"locked\":true,\"number\":1,\"request_settings\":[],\"response_objects\":[],\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"settings\":{\"general.default_host\":\"\",\"general.default_pci\":0,\"general.default_ttl\":3600},\"snippets\":[],\"staging\":true,\"testing\":true,\"vcls\":[],\"wordpress\":[]},\"active_version\":null}","originalRequest":{"name":"Get service details","description":"List detailed information on a specified service.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/details?version=1","path":["service","SU1Z0isxPaozGVKXdv0eY","details?version=1"],"host":["https://api.fastly.com"],"query":[{"key":"version","description":"Number identifying a version of the service."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Search for a service by name","request":{"name":"Search for a service by name","description":"Get a specific service by name.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/search","path":["service","search"],"host":["{{fastly_url}}"],"query":[{"key":"name","description":"The name of the service."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"comment\":\"\",\"created_at\":\"2020-04-27T19:40:49.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"test-service\",\"publish_key\":\"\",\"paused\":false,\"type\":\"vcl\",\"updated_at\":\"2020-04-27T19:40:49.000Z\",\"versions\":[{\"created_at\":\"2020-04-09T18:14:30.000Z\",\"updated_at\":\"2020-04-09T18:14:30.000Z\",\"deleted_at\":null,\"active\":true,\"comment\":\"\",\"deployed\":true,\"locked\":false,\"number\":1,\"staging\":false,\"testing\":false,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\"}]}","originalRequest":{"name":"Search for a service by name","description":"Get a specific service by name.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/search?name=test-service","path":["service","search?name=test-service"],"host":["https://api.fastly.com"],"query":[{"key":"name","description":"The name of the service."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get a service","request":{"name":"Get a service","description":"Get a specific service by id.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}","path":["service","{{service_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"comment\":\"\",\"created_at\":\"2020-04-27T19:40:49.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"test-service\",\"publish_key\":\"\",\"paused\":false,\"type\":\"vcl\",\"updated_at\":\"2020-04-27T19:40:49.000Z\",\"versions\":[{\"created_at\":\"2020-04-09T18:14:30.000Z\",\"updated_at\":\"2020-04-09T18:14:30.000Z\",\"deleted_at\":null,\"active\":true,\"comment\":\"\",\"deployed\":true,\"locked\":false,\"number\":1,\"staging\":false,\"testing\":false,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\"}]}","originalRequest":{"name":"Get a service","description":"Get a specific service by id.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY","path":["service","SU1Z0isxPaozGVKXdv0eY"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a service","request":{"name":"Update a service","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/services/service/#update-service)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}","path":["service","{{service_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"comment\":\"\",\"created_at\":\"2020-04-27T19:40:49.000Z\",\"customer_id\":\"x4xCwxxJxGCx123Rx5xTx\",\"deleted_at\":null,\"id\":\"SU1Z0isxPaozGVKXdv0eY\",\"name\":\"test-service\",\"publish_key\":\"\",\"paused\":false,\"type\":\"vcl\",\"updated_at\":\"2020-04-27T19:40:49.000Z\",\"versions\":[{\"created_at\":\"2020-04-09T18:14:30.000Z\",\"updated_at\":\"2020-04-09T18:14:30.000Z\",\"deleted_at\":null,\"active\":true,\"comment\":\"\",\"deployed\":true,\"locked\":false,\"number\":1,\"staging\":false,\"testing\":false,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\"}]}","originalRequest":{"name":"Update a service","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/services/service/#update-service)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY","path":["service","SU1Z0isxPaozGVKXdv0eY"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Delete a service","request":{"name":"Delete a service","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/services/service/#delete-service)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/service/{{service_id}}","path":["service","{{service_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Delete a service","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/services/service/#delete-service)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY","path":["service","SU1Z0isxPaozGVKXdv0eY"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"List the domains within a service","request":{"name":"List the domains within a service","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/services/service/#list-service-domains)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/domain","path":["service","{{service_id}}","domain"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"comment\":\"\",\"name\":\"www.example.com\",\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\",\"version\":1,\"created_at\":\"2020-03-15T20:10:09.000Z\",\"updated_at\":\"2020-03-15T20:10:09.000Z\",\"deleted_at\":null}]","originalRequest":{"name":"List the domains within a service","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/services/service/#list-service-domains)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/domain","path":["service","SU1Z0isxPaozGVKXdv0eY","domain"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Version","description":"A Version represents a specific instance of the configuration for a service. A Version can be cloned, locked, activated, or deactivated.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| active | boolean | Whether this is the active version or not. |\n| comment | string | A freeform descriptive note. |\n| deployed | boolean | Unused at this time. |\n| locked | boolean | Whether this version is locked or not. Objects can not be added or edited on locked versions. |\n| number | integer | The number of this version. |\n| staging | boolean | Unused at this time. |\n| testing | boolean | Unused at this time. |\n| service_id | string | Alphanumeric string identifying the service. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"List versions of a service","request":{"name":"List versions of a service","description":"List the versions for a particular service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version","path":["service","{{service_id}}","version"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"created_at\":\"2020-04-09T18:14:30.000Z\",\"updated_at\":\"2020-04-09T18:14:30.000Z\",\"deleted_at\":null,\"active\":true,\"comment\":\"\",\"deployed\":true,\"locked\":false,\"number\":1,\"staging\":false,\"testing\":false,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\"}]","originalRequest":{"name":"List versions of a service","description":"List the versions for a particular service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version","path":["service","SU1Z0isxPaozGVKXdv0eY","version"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a service version","request":{"name":"Create a service version","description":"Create a version for a particular service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"POST","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version","path":["service","{{service_id}}","version"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"number\":1,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\"}","originalRequest":{"name":"Create a service version","description":"Create a version for a particular service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"POST","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version","path":["service","SU1Z0isxPaozGVKXdv0eY","version"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get a version of a service","request":{"name":"Get a version of a service","description":"Get the version for a particular service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}","path":["service","{{service_id}}","version","{{version_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-04-09T18:14:30.000Z\",\"updated_at\":\"2020-04-09T18:14:30.000Z\",\"deleted_at\":null,\"active\":true,\"comment\":\"\",\"deployed\":true,\"locked\":false,\"number\":1,\"staging\":false,\"testing\":false,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\"}","originalRequest":{"name":"Get a version of a service","description":"Get the version for a particular service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a service version","request":{"name":"Update a service version","description":"Update a particular version for a particular service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}","path":["service","{{service_id}}","version","{{version_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-04-09T18:14:30.000Z\",\"updated_at\":\"2020-04-09T18:15:30.000Z\",\"deleted_at\":null,\"active\":true,\"comment\":\"\",\"deployed\":true,\"locked\":false,\"number\":1,\"staging\":false,\"testing\":false,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\"}","originalRequest":{"name":"Update a service version","description":"Update a particular version for a particular service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"urlencoded","urlencoded":[]}}}]},{"name":"Validate a service version","request":{"name":"Validate a service version","description":"Validate the version for a particular service and version.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/validate","path":["service","{{service_id}}","version","{{version_id}}","validate"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"status\":\"ok\"}","originalRequest":{"name":"Validate a service version","description":"Validate the version for a particular service and version.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/validate","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","validate"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Activate a service version","request":{"name":"Activate a service version","description":"Activate the current version.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/activate","path":["service","{{service_id}}","version","{{version_id}}","activate"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-04-09T18:14:30.000Z\",\"updated_at\":\"2020-04-09T18:15:30.000Z\",\"deleted_at\":null,\"active\":true,\"comment\":\"\",\"deployed\":true,\"locked\":false,\"number\":1,\"staging\":false,\"testing\":false,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\"}","originalRequest":{"name":"Activate a service version","description":"Activate the current version.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/activate","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","activate"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Deactivate a service version","request":{"name":"Deactivate a service version","description":"Deactivate the current version.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/deactivate","path":["service","{{service_id}}","version","{{version_id}}","deactivate"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-04-09T18:14:30.000Z\",\"updated_at\":\"2020-04-09T18:15:30.000Z\",\"deleted_at\":null,\"active\":false,\"comment\":\"\",\"deployed\":true,\"locked\":false,\"number\":1,\"staging\":false,\"testing\":false,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\"}","originalRequest":{"name":"Deactivate a service version","description":"Deactivate the current version.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/deactivate","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","deactivate"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Clone a service version","request":{"name":"Clone a service version","description":"Clone the current configuration into a new version.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/clone","path":["service","{{service_id}}","version","{{version_id}}","clone"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-04-09T18:14:30.000Z\",\"updated_at\":\"2020-04-09T18:15:30.000Z\",\"deleted_at\":null,\"active\":true,\"comment\":\"\",\"deployed\":true,\"locked\":false,\"number\":2,\"staging\":false,\"testing\":false,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\"}","originalRequest":{"name":"Clone a service version","description":"Clone the current configuration into a new version.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/clone","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","clone"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Lock a service version","request":{"name":"Lock a service version","description":"Locks the specified version.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PUT","url":{"raw":"{{fastly_url}}/service/{{service_id}}/version/{{version_id}}/lock","path":["service","{{service_id}}","version","{{version_id}}","lock"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"created_at\":\"2020-04-09T18:14:30.000Z\",\"updated_at\":\"2020-04-09T18:15:30.000Z\",\"deleted_at\":null,\"active\":true,\"comment\":\"\",\"deployed\":true,\"locked\":true,\"number\":1,\"staging\":false,\"testing\":false,\"service_id\":\"SU1Z0isxPaozGVKXdv0eY\"}","originalRequest":{"name":"Lock a service version","description":"Locks the specified version.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"PUT","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/version/1/lock","path":["service","SU1Z0isxPaozGVKXdv0eY","version","1","lock"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}]},{"name":"TLS","item":[{"name":"TLS Configuration","description":"Customers with access to multiple sets of IP pools are able to apply different configuration options to their TLS enabled domains.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| name | string | A custom name for your TLS configuration. |\n| relationships.dns_records.id | string | The IP address or hostname of the DNS record. |\n| relationships.service.id | string | Alphanumeric string identifying the service. |\n| type | string | Resource type. |\n| bulk | boolean | Signifies whether the configuration is used for Platform TLS or not. |\n| created_at | string | Date and time in ISO 8601 format. |\n| default | boolean | Signifies whether or not Fastly will use this configuration as a default when creating a new TLS Activation. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| http_protocols | array | HTTP protocols available on your configuration. |\n| id | string | Alphanumeric string identifying a TLS configuration. |\n| tls_protocols | array | TLS protocols available on your configuration. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"List TLS configurations","request":{"name":"List TLS configurations","description":"List all TLS configurations.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/tls/configurations","path":["tls","configurations"],"host":["{{fastly_url}}"],"query":[{"key":"filter[bulk]","description":"Optionally filters by the bulk attribute."},{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: dns_records."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\",\"attributes\":{\"bulk\":false,\"created_at\":\"2020-02-01T12:12:12.000Z\",\"default\":true,\"http_protocols\":[\"http/1.1\",\"http/2\"],\"name\":\"TLS Configuration A\",\"tls_protocols\":[1.1,1.2],\"updated_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"dns_records\":{\"data\":[{\"id\":\"151.101.2.133\",\"type\":\"dns_record\"},{\"id\":\"151.101.66.133\",\"type\":\"dns_record\"},{\"id\":\"151.101.130.133\",\"type\":\"dns_record\"},{\"id\":\"151.101.194.133\",\"type\":\"dns_record\"},{\"id\":\"d.sni.global.fastly.net\",\"type\":\"dns_record\"}]},\"service\":{\"data\":{\"id\":\"SU1Z0isxPaozGVKXdv0eY\",\"type\":\"service\"}}}}],\"included\":[{\"id\":\"151.101.2.133\",\"type\":\"dns_record\",\"attributes\":{\"record_type\":\"A\",\"region\":\"global\"}},{\"id\":\"151.101.66.133\",\"type\":\"dns_record\",\"attributes\":{\"record_type\":\"A\",\"region\":\"global\"}},{\"id\":\"151.101.130.133\",\"type\":\"dns_record\",\"attributes\":{\"record_type\":\"A\",\"region\":\"global\"}},{\"id\":\"151.101.194.133\",\"type\":\"dns_record\",\"attributes\":{\"record_type\":\"A\",\"region\":\"global\"}},{\"id\":\"d.sni.global.fastly.net\",\"type\":\"dns_record\",\"attributes\":{\"record_type\":\"CNAME\",\"region\":\"global\"}}],\"links\":{\"self\":\"https://api.fastly.com/tls/configurations?include=dns_records&page%5Bnumber%5D=1&page%5Bsize%5D=100\",\"first\":\"https://api.fastly.com/tls/configurations?include=dns_records&page%5Bnumber%5D=1&page%5Bsize%5D=100\",\"prev\":null,\"next\":null,\"last\":\"https://api.fastly.com/tls/configurations?include=dns_records&page%5Bnumber%5D=1&page%5Bsize%5D=100\"},\"meta\":{\"per_page\":100,\"current_page\":1,\"record_count\":1,\"total_pages\":1}}","originalRequest":{"name":"List TLS configurations","description":"List all TLS configurations.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/tls/configurations?include=dns_records&page%5Bnumber%5D=1&page%5Bsize%5D=20","path":["tls","configurations?include=dns_records&page%5Bnumber%5D=1&page%5Bsize%5D=20"],"host":["https://api.fastly.com"],"query":[{"key":"filter[bulk]","description":"Optionally filters by the bulk attribute."},{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: dns_records."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get a TLS configuration","request":{"name":"Get a TLS configuration","description":"Show a TLS configuration.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/tls/configurations/{{tls_configuration_id}}","path":["tls","configurations","{{tls_configuration_id}}"],"host":["{{fastly_url}}"],"query":[{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: dns_records."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\",\"attributes\":{\"bulk\":false,\"created_at\":\"2020-02-01T12:12:12.000Z\",\"default\":true,\"http_protocols\":[\"http/1.1\",\"http/2\"],\"name\":\"TLS Configuration A\",\"tls_protocols\":[1.1,1.2],\"updated_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"dns_records\":{\"data\":[{\"id\":\"151.101.2.133\",\"type\":\"dns_record\"},{\"id\":\"151.101.66.133\",\"type\":\"dns_record\"},{\"id\":\"151.101.130.133\",\"type\":\"dns_record\"},{\"id\":\"151.101.194.133\",\"type\":\"dns_record\"},{\"id\":\"d.sni.global.fastly.net\",\"type\":\"dns_record\"}]},\"service\":{\"data\":{\"id\":\"SU1Z0isxPaozGVKXdv0eY\",\"type\":\"service\"}}}},\"included\":[{\"id\":\"151.101.2.133\",\"type\":\"dns_record\",\"attributes\":{\"record_type\":\"A\",\"region\":\"global\"}},{\"id\":\"151.101.66.133\",\"type\":\"dns_record\",\"attributes\":{\"record_type\":\"A\",\"region\":\"global\"}},{\"id\":\"151.101.130.133\",\"type\":\"dns_record\",\"attributes\":{\"record_type\":\"A\",\"region\":\"global\"}},{\"id\":\"151.101.194.133\",\"type\":\"dns_record\",\"attributes\":{\"record_type\":\"A\",\"region\":\"global\"}},{\"id\":\"d.sni.global.fastly.net\",\"type\":\"dns_record\",\"attributes\":{\"record_type\":\"CNAME\",\"region\":\"global\"}}]}","originalRequest":{"name":"Get a TLS configuration","description":"Show a TLS configuration.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/tls/configurations/t7CguUGZzb2W9Euo5FoKa?include=dns_records","path":["tls","configurations","t7CguUGZzb2W9Euo5FoKa?include=dns_records"],"host":["https://api.fastly.com"],"query":[{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: dns_records."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a TLS configuration","request":{"name":"Update a TLS configuration","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/tls/configuration/#update-tls-config)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/tls/configurations/{{tls_configuration_id}}","path":["tls","configurations","{{tls_configuration_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_configuration\",\"attributes\":{\"name\":\"New TLS configuration name\"}}}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\",\"attributes\":{\"bulk\":false,\"created_at\":\"2020-02-01T12:12:12.000Z\",\"default\":true,\"http_protocols\":[\"http/1.1\",\"http/2\"],\"name\":\"New TLS configuration name\",\"tls_protocols\":[1.1,1.2],\"updated_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"service\":{\"data\":{\"id\":\"SU1Z0isxPaozGVKXdv0eY\",\"type\":\"service\"}}}}}","originalRequest":{"name":"Update a TLS configuration","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/tls/configuration/#update-tls-config)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/tls/configurations/t7CguUGZzb2W9Euo5FoKa","path":["tls","configurations","t7CguUGZzb2W9Euo5FoKa"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_configuration\",\"attributes\":{\"name\":\"New TLS configuration name\"}}}"}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Setting and Unsetting Mutual TLS on TLS Activations","description":"Mutual TLS can be added to existing TLS activations to allow for client-to-server authentication. In order to use mutual TLS, you must already have active server-side TLS using either custom certificates or an enabled Fastly-managed subscription.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| relationships.mutual_authentication.id | string | Alphanumeric string identifying a mutual authentication. |\n| relationships.tls_certificate.id | string | Alphanumeric string identifying a TLS certificate. |\n| relationships.tls_configuration.id | string | Alphanumeric string identifying a TLS configuration. |\n| relationships.tls_domain.id | string | The domain name. |\n| type | string | Resource type. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying a TLS activation. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"List TLS activations","request":{"name":"List TLS activations","description":"List all TLS activations.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/tls/activations","path":["tls","activations"],"host":["{{fastly_url}}"],"query":[{"key":"filter[mutual_authentication.id]","description":"Limit the returned rules to a specific mutual authentication ID (or null ID)."},{"key":"filter[tls_certificate.id]","description":"Limit the returned activations to a specific certificate."},{"key":"filter[tls_configuration.id]","description":"Limit the returned activations to a specific TLS configuration."},{"key":"filter[tls_domain.id]","description":"Limit the returned rules to a specific domain name."},{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: tls_certificate, tls_configuration, and tls_domain."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"aCtguUGZzb2W9Euo4moOR\",\"type\":\"tls_activation\",\"attributes\":{\"created_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"tls_certificate\":{\"data\":{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_certificate\"}},\"tls_configuration\":{\"data\":{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\"}},\"tls_domain\":{\"data\":{\"id\":\"example.com\",\"type\":\"tls_domain\"}},\"mutual_authentication\":{\"data\":{\"id\":\"SEAwSOsP7dEpTgGZdP7ZFw\",\"type\":\"mutual_authentication\"}}}}],\"links\":{\"self\":\"https://api.fastly.com/tls/activations?page%5Bnumber%5D=1&page%5Bsize%5D=100\",\"first\":\"https://api.fastly.com/tls/activations?page%5Bnumber%5D=1&page%5Bsize%5D=100\",\"prev\":null,\"next\":null,\"last\":\"https://api.fastly.com/tls/activations?page%5Bnumber%5D=1&page%5Bsize%5D=100\"},\"meta\":{\"per_page\":100,\"current_page\":1,\"record_count\":1,\"total_pages\":1}}","originalRequest":{"name":"List TLS activations","description":"List all TLS activations.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/tls/activations?include=tls_certificate%2Ctls_configuration%2Ctls_domain&page%5Bnumber%5D=1&page%5Bsize%5D=20","path":["tls","activations?include=tls_certificate%2Ctls_configuration%2Ctls_domain&page%5Bnumber%5D=1&page%5Bsize%5D=20"],"host":["https://api.fastly.com"],"query":[{"key":"filter[mutual_authentication.id]","description":"Limit the returned rules to a specific mutual authentication ID (or null ID)."},{"key":"filter[tls_certificate.id]","description":"Limit the returned activations to a specific certificate."},{"key":"filter[tls_configuration.id]","description":"Limit the returned activations to a specific TLS configuration."},{"key":"filter[tls_domain.id]","description":"Limit the returned rules to a specific domain name."},{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: tls_certificate, tls_configuration, and tls_domain."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Get a TLS activation","request":{"name":"Get a TLS activation","description":"Show a TLS activation.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/tls/activations/{{tls_activation_id}}","path":["tls","activations","{{tls_activation_id}}"],"host":["{{fastly_url}}"],"query":[{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: tls_certificate, tls_configuration, and tls_domain."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"aCtguUGZzb2W9Euo4moOR\",\"type\":\"tls_activation\",\"attributes\":{\"created_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"tls_certificate\":{\"data\":{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_certificate\"}},\"tls_configuration\":{\"data\":{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\"}},\"tls_domain\":{\"data\":{\"id\":\"example.com\",\"type\":\"tls_domain\"}},\"mutual_authentication\":{\"data\":{\"id\":\"SEAwSOsP7dEpTgGZdP7ZFw\",\"type\":\"mutual_authentication\"}}}}}","originalRequest":{"name":"Get a TLS activation","description":"Show a TLS activation.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/tls/activations/aCtguUGZzb2W9Euo4moOR?include=tls_certificate%2Ctls_configuration%2Ctls_domain","path":["tls","activations","aCtguUGZzb2W9Euo4moOR?include=tls_certificate%2Ctls_configuration%2Ctls_domain"],"host":["https://api.fastly.com"],"query":[{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: tls_certificate, tls_configuration, and tls_domain."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update Mutual TLS","request":{"name":"Update Mutual TLS","description":"Update the mutual authentication for the domain associated with this TLS activation. You may either 1) pass a valid mutual authentication ID to activate Mutual TLS, or 2) pass null as the ID to deactivate from Mutual TLS.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/tls/activations/{{tls_activation_id}}","path":["tls","activations","{{tls_activation_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_activation\",\"relationships\":{\"mutual_authentication\":{\"data\":{\"type\":\"mutual_authentication\",\"id\":\"SEAwSOsP7dEpTgGZdP7ZFw\"}}}}}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"aCtguUGZzb2W9Euo4moOR\",\"type\":\"tls_activation\",\"attributes\":{\"created_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"tls_certificate\":{\"data\":{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_certificate\"}},\"tls_configuration\":{\"data\":{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\"}},\"tls_domain\":{\"data\":{\"id\":\"example.com\",\"type\":\"tls_domain\"}},\"mutual_authentication\":{\"data\":{\"id\":\"SEAwSOsP7dEpTgGZdP7ZFw\",\"type\":\"mutual_authentication\"}}}}}","originalRequest":{"name":"Update Mutual TLS","description":"Update the mutual authentication for the domain associated with this TLS activation. You may either 1) pass a valid mutual authentication ID to activate Mutual TLS, or 2) pass null as the ID to deactivate from Mutual TLS.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/tls/activations/aCtguUGZzb2W9Euo4moOR","path":["tls","activations","aCtguUGZzb2W9Euo4moOR"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_activation\",\"relationships\":{\"mutual_authentication\":{\"data\":{\"type\":\"mutual_authentication\",\"id\":\"SEAwSOsP7dEpTgGZdP7ZFw\"}}}}}"}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Managing and Uploading Mutual Authentications","description":"The Mutual TLS API allows for client-to-server authentication using client-side X.509 authentication. The main Mutual Authentication object represents the certificate bundle and other configurations which support Mutual TLS for your domains.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| cert_bundle | string | One or more certificates. Enter each individual certificate blob on a new line. Must be PEM-formatted. Required. |\n| enforced | boolean | Determines whether Mutual TLS will fail closed (enforced) or fail open. A true value will require a successful Mutual TLS handshake for the connection to continue and will fail closed if unsuccessful. A false value will fail open and allow the connection to proceed. Optional. Defaults to true. |\n| name | string | A custom name for your mutual authentication. Required. |\n| relationships.tls_domains.id | string | The domain name. |\n| type | string | Resource type. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying a mutual authentication. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"List Mutual Authentications","request":{"name":"List Mutual Authentications","description":"List all mutual authentications.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/tls/mutual_authentications","path":["tls","mutual_authentications"],"host":["{{fastly_url}}"],"query":[{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"SEAwSOsP7dEpTgGZdP7ZFw\",\"type\":\"mutual_authentication\",\"attributes\":{\"created_at\":\"2020-02-01T12:12:12.000Z\",\"enforced\":true,\"name\":\"Mutual Authentication A\",\"updated_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"tls_domains\":{\"data\":[{\"id\":\"DOMAIN_NAME\",\"type\":\"tls_domain\"}]}}}],\"links\":{\"self\":\"https://api.fastly.com/tls/mutual_authentications?page%5Bnumber%5D=1&page%5Bsize%5D=100\",\"first\":\"https://api.fastly.com/tls/mutual_authentications?page%5Bnumber%5D=1&page%5Bsize%5D=100\",\"prev\":null,\"next\":null,\"last\":\"https://api.fastly.com/tls/mutual_authentications?page%5Bnumber%5D=1&page%5Bsize%5D=100\"},\"meta\":{\"per_page\":100,\"current_page\":1,\"record_count\":1,\"total_pages\":1}}","originalRequest":{"name":"List Mutual Authentications","description":"List all mutual authentications.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/tls/mutual_authentications?page%5Bnumber%5D=1&page%5Bsize%5D=20","path":["tls","mutual_authentications?page%5Bnumber%5D=1&page%5Bsize%5D=20"],"host":["https://api.fastly.com"],"query":[{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a Mutual Authentication","request":{"name":"Create a Mutual Authentication","description":"Create a mutual authentication using a bundle of certificates to enable client-to-server mutual TLS.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/tls/mutual_authentications","path":["tls","mutual_authentications"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"mutual_authentication\",\"attributes\":{\"cert_bundle\":\"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n\",\"name\":\"Mutual Authentication A\"}}}"}},"response":[{"status":"201 Created","name":"201 Created","code":201,"header":[],"body":"{\"data\":{\"id\":\"aCtguUGZzb2W9Euo4moOR\",\"type\":\"mutual_authentication\",\"attributes\":{\"created_at\":\"2020-02-01T12:12:12.000Z\",\"enforced\":true,\"name\":\"Mutual Authentication A\",\"updated_at\":\"2020-02-01T12:12:12.000Z\"}}}","originalRequest":{"name":"Create a Mutual Authentication","description":"Create a mutual authentication using a bundle of certificates to enable client-to-server mutual TLS.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/tls/mutual_authentications","path":["tls","mutual_authentications"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"mutual_authentication\",\"attributes\":{\"cert_bundle\":\"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n\",\"name\":\"Mutual Authentication A\"}}}"}}}]},{"name":"Get a Mutual Authentication","request":{"name":"Get a Mutual Authentication","description":"Show a Mutual Authentication.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/tls/mutual_authentications/{{mutual_authentication_id}}","path":["tls","mutual_authentications","{{mutual_authentication_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"SEAwSOsP7dEpTgGZdP7ZFw\",\"type\":\"mutual_authentication\",\"attributes\":{\"created_at\":\"2020-02-01T12:12:12.000Z\",\"enforced\":true,\"name\":\"Mutual Authentication A\",\"updated_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"tls_domains\":{\"data\":[{\"id\":\"DOMAIN_NAME\",\"type\":\"tls_domain\"}]}}}}","originalRequest":{"name":"Get a Mutual Authentication","description":"Show a Mutual Authentication.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/tls/mutual_authentications/SEAwSOsP7dEpTgGZdP7ZFw","path":["tls","mutual_authentications","SEAwSOsP7dEpTgGZdP7ZFw"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Delete a Mutual TLS","request":{"name":"Delete a Mutual TLS","description":"Remove a Mutual TLS authentication.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/tls/mutual_authentications/{{mutual_authentication_id}}","path":["tls","mutual_authentications","{{mutual_authentication_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"204 No Content","name":"204 No Content","code":204,"header":[],"originalRequest":{"name":"Delete a Mutual TLS","description":"Remove a Mutual TLS authentication.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/tls/mutual_authentications/SEAwSOsP7dEpTgGZdP7ZFw","path":["tls","mutual_authentications","SEAwSOsP7dEpTgGZdP7ZFw"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a Mutual Authentication","request":{"name":"Update a Mutual Authentication","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/tls/mutual-tls/authentication/#patch-mutual-authentication)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/tls/mutual_authentications/{{mutual_authentication_id}}","path":["tls","mutual_authentications","{{mutual_authentication_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"mutual_authentication\",\"attributes\":{\"name\":\"Mutual Authentication B\",\"enforced\":false}}}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"SEAwSOsP7dEpTgGZdP7ZFw\",\"type\":\"mutual_authentication\",\"attributes\":{\"created_at\":\"2020-02-01T12:12:12.000Z\",\"enforced\":false,\"name\":\"Mutual Authentication B\",\"updated_at\":\"2022-02-01T12:12:12.000Z\"},\"relationships\":{\"tls_domains\":{\"data\":[{\"id\":\"DOMAIN_NAME\",\"type\":\"tls_domain\"}]}}}}","originalRequest":{"name":"Update a Mutual Authentication","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/tls/mutual-tls/authentication/#patch-mutual-authentication)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/tls/mutual_authentications/SEAwSOsP7dEpTgGZdP7ZFw","path":["tls","mutual_authentications","SEAwSOsP7dEpTgGZdP7ZFw"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"mutual_authentication\",\"attributes\":{\"name\":\"Mutual Authentication B\",\"enforced\":false}}}"}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Bulk Certificates","description":"Available to Platform TLS customers, these endpoints streamline the upload, deployment and management of large numbers of TLS certificates. A certificate is used to terminate TLS traffic for one or more of your fully qualified domain names (domains). Uploading a new certificate automatically enables TLS for all domains listed as Subject Alternative Names (SAN entries) on the certificate.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| allow_untrusted_root | boolean | Allow certificates that chain to untrusted roots. |\n| cert_blob | string | The PEM-formatted certificate blob. Required. |\n| intermediates_blob | string | The PEM-formatted chain of intermediate blobs. Required. |\n| relationships.tls_configurations.id | string | Alphanumeric string identifying a TLS configuration. |\n| relationships.tls_domains.id | string | The domain name. |\n| type | string | Resource type. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying a TLS bulk certificate. |\n| not_after | string | Time-stamp (GMT) when the certificate will expire. Must be in the future to be used to terminate TLS traffic. |\n| not_before | string | Time-stamp (GMT) when the certificate will become valid. Must be in the past to be used to terminate TLS traffic. |\n| replace | boolean | A recommendation from Fastly indicating the key associated with this certificate is in need of rotation. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"List certificates","request":{"name":"List certificates","description":"List all certificates.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/tls/bulk/certificates","path":["tls","bulk","certificates"],"host":["{{fastly_url}}"],"query":[{"key":"filter[tls_domain.id]","description":"Filter certificates by their matching, fully-qualified domain name."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."},{"key":"sort","description":"The order in which to list the results by creation date."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_bulk_certificate\",\"attributes\":{\"not_after\":\"2020-06-06T18:14:32.000Z\",\"not_before\":\"2020-06-06T18:14:32.000Z\",\"created_at\":\"2020-06-06T18:14:32.000Z\",\"updated_at\":\"2020-06-06T18:14:32.000Z\",\"replace\":false},\"relationships\":{\"tls_configurations\":{\"data\":[{\"type\":\"tls_configuration\",\"id\":\"t7CguUGZzb2W9Euo5FoKa\"}]},\"tls_domains\":{\"data\":[{\"type\":\"tls_domain\",\"id\":\"DOMAIN_NAME\"}]}}}]}","originalRequest":{"name":"List certificates","description":"List all certificates.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/tls/bulk/certificates?page%5Bnumber%5D=1&page%5Bsize%5D=20&sort=created_at","path":["tls","bulk","certificates?page%5Bnumber%5D=1&page%5Bsize%5D=20&sort=created_at"],"host":["https://api.fastly.com"],"query":[{"key":"filter[tls_domain.id]","description":"Filter certificates by their matching, fully-qualified domain name."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."},{"key":"sort","description":"The order in which to list the results by creation date."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Upload a certificate","request":{"name":"Upload a certificate","description":"Upload a new certificate. TLS domains are automatically enabled upon certificate creation. If a domain is already enabled on a previously uploaded certificate, that domain will be updated to use the new certificate for all future TLS handshake requests.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/tls/bulk/certificates","path":["tls","bulk","certificates"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_bulk_certificate\",\"attributes\":{\"allow_untrusted_root\":false,\"cert_blob\":\"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n\",\"intermediates_blob\":\"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n\"},\"relationships\":{\"tls_configurations\":{\"data\":[{\"type\":\"tls_configuration\",\"id\":\"t7CguUGZzb2W9Euo5FoKa\"}]}}}}"}},"response":[{"status":"201 Created","name":"201 Created","code":201,"header":[],"body":"{\"data\":{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_bulk_certificate\",\"attributes\":{\"not_after\":\"2020-06-06T18:14:32.000Z\",\"not_before\":\"2020-06-06T18:14:32.000Z\",\"created_at\":\"2020-06-06T18:14:32.000Z\",\"updated_at\":\"2020-06-06T18:14:32.000Z\",\"replace\":false},\"relationships\":{\"tls_configurations\":{\"data\":[{\"type\":\"tls_configuration\",\"id\":\"t7CguUGZzb2W9Euo5FoKa\"}]},\"tls_domains\":{\"data\":[{\"type\":\"tls_domain\",\"id\":\"DOMAIN_NAME\"}]}}}}","originalRequest":{"name":"Upload a certificate","description":"Upload a new certificate. TLS domains are automatically enabled upon certificate creation. If a domain is already enabled on a previously uploaded certificate, that domain will be updated to use the new certificate for all future TLS handshake requests.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/tls/bulk/certificates","path":["tls","bulk","certificates"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_bulk_certificate\",\"attributes\":{\"allow_untrusted_root\":false,\"cert_blob\":\"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n\",\"intermediates_blob\":\"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n\"},\"relationships\":{\"tls_configurations\":{\"data\":[{\"type\":\"tls_configuration\",\"id\":\"t7CguUGZzb2W9Euo5FoKa\"}]}}}}"}}}]},{"name":"Get a certificate","request":{"name":"Get a certificate","description":"Retrieve a single certificate.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/tls/bulk/certificates/{{certificate_id}}","path":["tls","bulk","certificates","{{certificate_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_bulk_certificate\",\"attributes\":{\"not_after\":\"2020-06-06T18:14:32.000Z\",\"not_before\":\"2020-06-06T18:14:32.000Z\",\"created_at\":\"2020-06-06T18:14:32.000Z\",\"updated_at\":\"2020-06-06T18:14:32.000Z\",\"replace\":false},\"relationships\":{\"tls_configurations\":{\"data\":[{\"type\":\"tls_configuration\",\"id\":\"t7CguUGZzb2W9Euo5FoKa\"}]},\"tls_domains\":{\"data\":[{\"type\":\"tls_domain\",\"id\":\"DOMAIN_NAME\"}]}}}}","originalRequest":{"name":"Get a certificate","description":"Retrieve a single certificate.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/tls/bulk/certificates/cRTguUGZzb2W9Euo4moOr","path":["tls","bulk","certificates","cRTguUGZzb2W9Euo4moOr"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Delete a certificate","request":{"name":"Delete a certificate","description":"Destroy a certificate. This disables TLS for all domains listed as SAN entries.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/tls/bulk/certificates/{{certificate_id}}","path":["tls","bulk","certificates","{{certificate_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"204 No Content","name":"204 No Content","code":204,"header":[],"originalRequest":{"name":"Delete a certificate","description":"Destroy a certificate. This disables TLS for all domains listed as SAN entries.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/tls/bulk/certificates/cRTguUGZzb2W9Euo4moOr","path":["tls","bulk","certificates","cRTguUGZzb2W9Euo4moOr"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a certificate","request":{"name":"Update a certificate","description":"Replace a certificate with a newly reissued certificate. By using this endpoint, the original certificate will cease to be used for future TLS handshakes. Thus, only SAN entries that appear in the replacement certificate will become TLS enabled. Any SAN entries that are missing in the replacement certificate will become disabled.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/tls/bulk/certificates/{{certificate_id}}","path":["tls","bulk","certificates","{{certificate_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_bulk_certificate\",\"attributes\":{\"allow_untrusted_root\":false,\"cert_blob\":\"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n\",\"intermediates_blob\":\"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n\"}}}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_bulk_certificate\",\"attributes\":{\"not_after\":\"2020-06-06T18:14:32.000Z\",\"not_before\":\"2020-06-06T18:14:32.000Z\",\"created_at\":\"2020-06-06T18:14:32.000Z\",\"updated_at\":\"2020-06-06T18:14:32.000Z\",\"replace\":false},\"relationships\":{\"tls_configurations\":{\"data\":[{\"type\":\"tls_configuration\",\"id\":\"t7CguUGZzb2W9Euo5FoKa\"}]},\"tls_domains\":{\"data\":[{\"type\":\"tls_domain\",\"id\":\"DOMAIN_NAME\"}]}}}}","originalRequest":{"name":"Update a certificate","description":"Replace a certificate with a newly reissued certificate. By using this endpoint, the original certificate will cease to be used for future TLS handshakes. Thus, only SAN entries that appear in the replacement certificate will become TLS enabled. Any SAN entries that are missing in the replacement certificate will become disabled.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/tls/bulk/certificates/cRTguUGZzb2W9Euo4moOr","path":["tls","bulk","certificates","cRTguUGZzb2W9Euo4moOr"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_bulk_certificate\",\"attributes\":{\"allow_untrusted_root\":false,\"cert_blob\":\"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n\",\"intermediates_blob\":\"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n\"}}}"}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"TLS Subscriptions","description":"The TLS subscriptions API allows you to programmatically generate TLS certificates that are procured and renewed by Fastly. Once a subscription is created for a given hostname or wildcard domain, DNS records are checked to ensure that the domain on the subscription is owned by the subscription creator. Provided DNS records are maintained, TLS certificates will automatically renew.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| certificate_authority | string | The entity that issues and certifies the TLS certificates for your subscription. |\n| relationships.common_name.id | string | The domain name. |\n| relationships.tls_certificates.id | string | Alphanumeric string identifying a TLS certificate. |\n| relationships.tls_configuration.id | string | Alphanumeric string identifying a TLS configuration. |\n| relationships.tls_domains.id | string | The domain name. |\n| type | string | Resource type. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| state | string | The current state of your subscription. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"List TLS subscriptions","request":{"name":"List TLS subscriptions","description":"List all TLS subscriptions.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/tls/subscriptions","path":["tls","subscriptions"],"host":["{{fastly_url}}"],"query":[{"key":"filter[has_active_order]","description":"Limit the returned subscriptions to those that have currently active orders. Permitted values: true."},{"key":"filter[state]","description":"Limit the returned subscriptions by state. Valid values are pending, processing, issued, and renewing. Accepts parameters: not (e.g., filter[state][not]=renewing)."},{"key":"filter[tls_domains.id]","description":"Limit the returned subscriptions to those that include the specific domain."},{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: tls_authorizations and tls_authorizations.globalsign_email_challenge."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."},{"key":"sort","description":"The order in which to list the results by creation date."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"sU3guUGZzb2W9Euo4Mo0r\",\"type\":\"tls_subscription\",\"attributes\":{\"certificate_authority\":\"lets-encrypt\",\"created_at\":\"2020-02-01T12:12:12.000Z\",\"state\":\"issued\",\"has_active_order\":false,\"updated_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"common_name\":{\"data\":{\"id\":\"DOMAIN_NAME\",\"type\":\"tls_domain\"}},\"tls_authorizations\":{\"data\":[{\"id\":\"AuTguUGZzb2W9Euo4moOr\",\"type\":\"tls_authorization\"}]},\"tls_certificates\":{\"data\":[{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_certificate\"}]},\"tls_domains\":{\"data\":{\"id\":\"DOMAIN_NAME\",\"type\":\"tls_domain\"}},\"tls_configuration\":{\"data\":{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\"}}}}],\"included\":[{\"id\":\"AuTguUGZzb2W9Euo4moOr\",\"type\":\"tls_authorization\",\"attributes\":{\"challenges\":[{\"type\":\"managed-dns\",\"record_type\":\"CNAME\",\"record_name\":\"ACME_CHALLENGE_HOSTNAME\",\"values\":[\"FASTLY_VALIDATION_HOSTNAME\"]},{\"type\":\"managed-http-cname\",\"record_type\":\"CNAME\",\"record_name\":\"DOMAIN_NAME\",\"values\":[\"FASTLY_CNAME\"]},{\"type\":\"managed-http-a\",\"record_type\":\"A\",\"record_name\":\"DOMAIN_NAME\",\"values\":[\"FASTLY_IP_ADDRESSES\"]}],\"created_at\":\"2020-02-01T12:12:12.000Z\",\"state\":\"pending\",\"updated_at\":\"2020-02-01T12:12:12.000Z\",\"warnings\":null}}],\"links\":{\"self\":\"https://api.fastly.com/tls/subscriptions?page%5Bnumber%5D=1&page%5Bsize%5D=100\",\"first\":\"https://api.fastly.com/tls/subscriptions?page%5Bnumber%5D=1&page%5Bsize%5D=100\",\"prev\":null,\"next\":null,\"last\":\"https://api.fastly.com/tls/subscriptions?page%5Bnumber%5D=1&page%5Bsize%5D=100\"},\"meta\":{\"per_page\":100,\"current_page\":1,\"record_count\":1,\"total_pages\":1}}","originalRequest":{"name":"List TLS subscriptions","description":"List all TLS subscriptions.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/tls/subscriptions?include=tls_authorizations&page%5Bnumber%5D=1&page%5Bsize%5D=20&sort=created_at","path":["tls","subscriptions?include=tls_authorizations&page%5Bnumber%5D=1&page%5Bsize%5D=20&sort=created_at"],"host":["https://api.fastly.com"],"query":[{"key":"filter[has_active_order]","description":"Limit the returned subscriptions to those that have currently active orders. Permitted values: true."},{"key":"filter[state]","description":"Limit the returned subscriptions by state. Valid values are pending, processing, issued, and renewing. Accepts parameters: not (e.g., filter[state][not]=renewing)."},{"key":"filter[tls_domains.id]","description":"Limit the returned subscriptions to those that include the specific domain."},{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: tls_authorizations and tls_authorizations.globalsign_email_challenge."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."},{"key":"sort","description":"The order in which to list the results by creation date."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a TLS subscription","request":{"name":"Create a TLS subscription","description":"Create a new TLS subscription. This response includes a list of possible challenges to verify domain ownership.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/tls/subscriptions","path":["tls","subscriptions"],"host":["{{fastly_url}}"],"query":[{"key":"force","description":"A flag that allows you to edit and delete a subscription with active domains. Valid to use on PATCH and DELETE actions. As a warning, removing an active domain from a subscription or forcing the deletion of a subscription may result in breaking TLS termination to that domain."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_subscription\",\"attributes\":{\"certificate_authority\":\"lets-encrypt\"},\"relationships\":{\"tls_domains\":{\"data\":[{\"type\":\"tls_domain\",\"id\":\"DOMAIN_NAME\"}]},\"tls_configuration\":{\"data\":{\"type\":\"tls_configuration\",\"id\":\"t7CguUGZzb2W9Euo5FoKa\"}}}}}"}},"response":[{"status":"201 Created","name":"201 Created","code":201,"header":[],"body":"{\"data\":{\"id\":\"sU3guUGZzb2W9Euo4Mo0r\",\"type\":\"tls_subscription\",\"attributes\":{\"certificate_authority\":\"lets-encrypt\",\"created_at\":\"2020-02-01T12:12:12.000Z\",\"state\":\"pending\",\"updated_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"common_name\":{\"data\":{\"id\":\"DOMAIN_NAME\",\"type\":\"tls_domain\"}},\"tls_authorizations\":{\"data\":[{\"id\":\"AuTguUGZzb2W9Euo4moOr\",\"type\":\"tls_authorization\"}]},\"tls_certificates\":{\"data\":[]},\"tls_domains\":{\"data\":{\"id\":\"DOMAIN_NAME\",\"type\":\"tls_domain\"}},\"tls_configuration\":{\"data\":[{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\"}]}}},\"included\":[{\"id\":\"AuTguUGZzb2W9Euo4moOr\",\"type\":\"tls_authorization\",\"attributes\":{\"challenges\":[{\"type\":\"managed-dns\",\"record_type\":\"CNAME\",\"record_name\":\"ACME_CHALLENGE_HOSTNAME\",\"values\":[\"FASTLY_VALIDATION_HOSTNAME\"]},{\"type\":\"managed-http-cname\",\"record_type\":\"CNAME\",\"record_name\":\"DOMAIN_NAME\",\"values\":[\"FASTLY_CNAME\"]},{\"type\":\"managed-http-a\",\"record_type\":\"A\",\"record_name\":\"DOMAIN_NAME\",\"values\":[\"FASTLY_IP_ADDRESSES\"]}],\"created_at\":\"2020-02-01T12:12:12.000Z\",\"state\":\"pending\",\"updated_at\":\"2020-02-01T12:12:12.000Z\",\"warnings\":null}}]}","originalRequest":{"name":"Create a TLS subscription","description":"Create a new TLS subscription. This response includes a list of possible challenges to verify domain ownership.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/tls/subscriptions?force=true","path":["tls","subscriptions?force=true"],"host":["https://api.fastly.com"],"query":[{"key":"force","description":"A flag that allows you to edit and delete a subscription with active domains. Valid to use on PATCH and DELETE actions. As a warning, removing an active domain from a subscription or forcing the deletion of a subscription may result in breaking TLS termination to that domain."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_subscription\",\"attributes\":{\"certificate_authority\":\"lets-encrypt\"},\"relationships\":{\"tls_domains\":{\"data\":[{\"type\":\"tls_domain\",\"id\":\"DOMAIN_NAME\"}]},\"tls_configuration\":{\"data\":{\"type\":\"tls_configuration\",\"id\":\"t7CguUGZzb2W9Euo5FoKa\"}}}}}"}}}]},{"name":"Get a TLS subscription","request":{"name":"Get a TLS subscription","description":"Show a TLS subscription.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/tls/subscriptions/{{tls_subscription_id}}","path":["tls","subscriptions","{{tls_subscription_id}}"],"host":["{{fastly_url}}"],"query":[{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: tls_authorizations and tls_authorizations.globalsign_email_challenge."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"sU3guUGZzb2W9Euo4Mo0r\",\"type\":\"tls_subscription\",\"attributes\":{\"certificate_authority\":\"lets-encrypt\",\"created_at\":\"2020-02-01T12:12:12.000Z\",\"state\":\"issued\",\"has_active_order\":false,\"updated_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"common_name\":{\"data\":{\"id\":\"DOMAIN_NAME\",\"type\":\"tls_domain\"}},\"tls_authorizations\":{\"data\":[{\"id\":\"AuTguUGZzb2W9Euo4moOr\",\"type\":\"tls_authorization\"}]},\"tls_certificates\":{\"data\":[{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_certificate\"}]},\"tls_domains\":{\"data\":{\"id\":\"DOMAIN_NAME\",\"type\":\"tls_domain\"}},\"tls_configuration\":{\"data\":[{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\"}]}}},\"included\":[{\"id\":\"AuTguUGZzb2W9Euo4moOr\",\"type\":\"tls_authorization\",\"attributes\":{\"challenges\":[{\"type\":\"managed-dns\",\"record_type\":\"CNAME\",\"record_name\":\"ACME_CHALLENGE_HOSTNAME\",\"values\":[\"FASTLY_VALIDATION_HOSTNAME\"]},{\"type\":\"managed-http-cname\",\"record_type\":\"CNAME\",\"record_name\":\"DOMAIN_NAME\",\"values\":[\"FASTLY_CNAME\"]},{\"type\":\"managed-http-a\",\"record_type\":\"A\",\"record_name\":\"DOMAIN_NAME\",\"values\":[\"FASTLY_IP_ADDRESSES\"]}],\"created_at\":\"2020-02-01T12:12:12.000Z\",\"state\":\"passing\",\"updated_at\":\"2020-02-01T12:12:12.000Z\",\"warnings\":null}}]}","originalRequest":{"name":"Get a TLS subscription","description":"Show a TLS subscription.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/tls/subscriptions/sU3guUGZzb2W9Euo4Mo0r?include=tls_authorizations","path":["tls","subscriptions","sU3guUGZzb2W9Euo4Mo0r?include=tls_authorizations"],"host":["https://api.fastly.com"],"query":[{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: tls_authorizations and tls_authorizations.globalsign_email_challenge."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Delete a TLS subscription","request":{"name":"Delete a TLS subscription","description":"Destroy a TLS subscription. A subscription cannot be destroyed if there are domains in the TLS enabled state.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/tls/subscriptions/{{tls_subscription_id}}","path":["tls","subscriptions","{{tls_subscription_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"204 No Content","name":"204 No Content","code":204,"header":[],"originalRequest":{"name":"Delete a TLS subscription","description":"Destroy a TLS subscription. A subscription cannot be destroyed if there are domains in the TLS enabled state.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/tls/subscriptions/sU3guUGZzb2W9Euo4Mo0r","path":["tls","subscriptions","sU3guUGZzb2W9Euo4Mo0r"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a TLS subscription","request":{"name":"Update a TLS subscription","description":"Change the TLS domains or common name associated with this subscription, or update the TLS configuration for this set of domains.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/tls/subscriptions/{{tls_subscription_id}}","path":["tls","subscriptions","{{tls_subscription_id}}"],"host":["{{fastly_url}}"],"query":[{"key":"force","description":"A flag that allows you to edit and delete a subscription with active domains. Valid to use on PATCH and DELETE actions. As a warning, removing an active domain from a subscription or forcing the deletion of a subscription may result in breaking TLS termination to that domain."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_subscription\",\"relationships\":{\"common_name\":{\"data\":{\"type\":\"tls_domain\",\"id\":\"DOMAIN_NAME\"}},\"tls_domains\":{\"data\":[{\"type\":\"tls_domain\",\"id\":\"DOMAIN_NAME\"}]},\"tls_configuration\":{\"data\":{\"type\":\"tls_configuration\",\"id\":\"t7CguUGZzb2W9Euo5FoKa\"}}}}}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"sU3guUGZzb2W9Euo4Mo0r\",\"type\":\"tls_subscription\",\"attributes\":{\"certificate_authority\":\"lets-encrypt\",\"created_at\":\"2020-02-01T12:12:12.000Z\",\"state\":\"processing\",\"has_active_order\":true,\"updated_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"common_name\":{\"data\":{\"id\":\"DOMAIN_NAME\",\"type\":\"tls_domain\"}},\"tls_authorizations\":{\"data\":[{\"id\":\"AuTguUGZzb2W9Euo4moOr\",\"type\":\"tls_authorization\"}]},\"tls_certificates\":{\"data\":[{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_certificate\"}]},\"tls_domains\":{\"data\":{\"id\":\"DOMAIN_NAME\",\"type\":\"tls_domain\"}},\"tls_configuration\":{\"data\":[{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\"}]}}},\"included\":[{\"id\":\"AuTguUGZzb2W9Euo4moOr\",\"type\":\"tls_authorization\",\"attributes\":{\"challenges\":[{\"type\":\"managed-dns\",\"record_type\":\"CNAME\",\"record_name\":\"ACME_CHALLENGE_HOSTNAME\",\"values\":[\"FASTLY_VALIDATION_HOSTNAME\"]},{\"type\":\"managed-http-cname\",\"record_type\":\"CNAME\",\"record_name\":\"DOMAIN_NAME\",\"values\":[\"FASTLY_CNAME\"]},{\"type\":\"managed-http-a\",\"record_type\":\"A\",\"record_name\":\"DOMAIN_NAME\",\"values\":[\"FASTLY_IP_ADDRESSES\"]}],\"created_at\":\"2020-02-01T12:12:12.000Z\",\"state\":\"passing\",\"updated_at\":\"2020-02-01T12:12:12.000Z\",\"warnings\":null}}]}","originalRequest":{"name":"Update a TLS subscription","description":"Change the TLS domains or common name associated with this subscription, or update the TLS configuration for this set of domains.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/tls/subscriptions/sU3guUGZzb2W9Euo4Mo0r?force=true","path":["tls","subscriptions","sU3guUGZzb2W9Euo4Mo0r?force=true"],"host":["https://api.fastly.com"],"query":[{"key":"force","description":"A flag that allows you to edit and delete a subscription with active domains. Valid to use on PATCH and DELETE actions. As a warning, removing an active domain from a subscription or forcing the deletion of a subscription may result in breaking TLS termination to that domain."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_subscription\",\"relationships\":{\"common_name\":{\"data\":{\"type\":\"tls_domain\",\"id\":\"DOMAIN_NAME\"}},\"tls_domains\":{\"data\":[{\"type\":\"tls_domain\",\"id\":\"DOMAIN_NAME\"}]},\"tls_configuration\":{\"data\":{\"type\":\"tls_configuration\",\"id\":\"t7CguUGZzb2W9Euo5FoKa\"}}}}}"}}}]},{"name":"Creates a GlobalSign email challenge","request":{"name":"Creates a GlobalSign email challenge","description":"Creates an email challenge for a domain on a GlobalSign subscription. An email challenge will generate an email that can be used to validate domain ownership. If this challenge is created, then the domain can only be validated using email for the given subscription.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/tls/subscriptions/{{tls_subscription_id}}/authorizations/{{tls_authorization_id}}/globalsign_email_challenges","path":["tls","subscriptions","{{tls_subscription_id}}","authorizations","{{tls_authorization_id}}","globalsign_email_challenges"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"globalsign_email_challenge\",\"attributes\":{\"preferred_email\":\"admin@example.com\"}}}"}},"response":[{"status":"201 Created","name":"201 Created","code":201,"header":[],"body":"{\"data\":{\"id\":\"9RPIWHj89UrF3ZvUJ20XsQ\",\"type\":\"globalsign_email_challenge\",\"attributes\":{\"created_at\":\"2020-02-01T12:12:12Z\",\"verified_at\":null,\"state\":\"setup\",\"emails\":[\"admin@example.com\"],\"preferred_email\":\"admin@example.com\",\"sent_at\":null},\"relationships\":{\"data\":{\"id\":\"xHNEnd0ZgRJwt27K6vI4wg\",\"type\":\"tls_authorization\"}}}}","originalRequest":{"name":"Creates a GlobalSign email challenge","description":"Creates an email challenge for a domain on a GlobalSign subscription. An email challenge will generate an email that can be used to validate domain ownership. If this challenge is created, then the domain can only be validated using email for the given subscription.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/tls/subscriptions/sU3guUGZzb2W9Euo4Mo0r/authorizations/aU3guUGZzb2W9Euo4Mo0r/globalsign_email_challenges","path":["tls","subscriptions","sU3guUGZzb2W9Euo4Mo0r","authorizations","aU3guUGZzb2W9Euo4Mo0r","globalsign_email_challenges"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"globalsign_email_challenge\",\"attributes\":{\"preferred_email\":\"admin@example.com\"}}}"}}}]},{"name":"Delete a GlobalSign email challenge","request":{"name":"Delete a GlobalSign email challenge","description":"Deletes a GlobalSign email challenge. After a GlobalSign email challenge is deleted, the domain can use HTTP and DNS validation methods again.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/tls/subscriptions/{{tls_subscription_id}}/authorizations/{{tls_authorization_id}}/globalsign_email_challenges/{{globalsign_email_challenge_id}}","path":["tls","subscriptions","{{tls_subscription_id}}","authorizations","{{tls_authorization_id}}","globalsign_email_challenges","{{globalsign_email_challenge_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"204 No Content","name":"204 No Content","code":204,"header":[],"originalRequest":{"name":"Delete a GlobalSign email challenge","description":"Deletes a GlobalSign email challenge. After a GlobalSign email challenge is deleted, the domain can use HTTP and DNS validation methods again.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/tls/subscriptions/{{tls_subscription_id}}/authorizations/{{tls_authorization_id}}/globalsign_email_challenges/{{globalsign_email_challenge_id}}","path":["tls","subscriptions","{{tls_subscription_id}}","authorizations","{{tls_authorization_id}}","globalsign_email_challenges","{{globalsign_email_challenge_id}}"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Custom TLS certificates","item":[{"name":"TLS Activations","description":"TLS activations.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| relationships.tls_certificate.id | string | Alphanumeric string identifying a TLS certificate. |\n| relationships.tls_configuration.id | string | Alphanumeric string identifying a TLS configuration. |\n| relationships.tls_domain.id | string | The domain name. |\n| type | string | Resource type. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying a TLS activation. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"List TLS activations","request":{"name":"List TLS activations","description":"List all TLS activations.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/tls/activations","path":["tls","activations"],"host":["{{fastly_url}}"],"query":[{"key":"filter[tls_certificate.id]","description":"Limit the returned activations to a specific certificate."},{"key":"filter[tls_configuration.id]","description":"Limit the returned activations to a specific TLS configuration."},{"key":"filter[tls_domain.id]","description":"Limit the returned rules to a specific domain name."},{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: tls_certificate, tls_configuration, and tls_domain."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"aCtguUGZzb2W9Euo4moOR\",\"type\":\"tls_activation\",\"attributes\":{\"created_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"tls_certificate\":{\"data\":{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_certificate\"}},\"tls_configuration\":{\"data\":{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\"}},\"tls_domain\":{\"data\":{\"id\":\"example.com\",\"type\":\"tls_domain\"}}}}],\"links\":{\"self\":\"https://api.fastly.com/tls/activations?page%5Bnumber%5D=1&page%5Bsize%5D=100\",\"first\":\"https://api.fastly.com/tls/activations?page%5Bnumber%5D=1&page%5Bsize%5D=100\",\"prev\":null,\"next\":null,\"last\":\"https://api.fastly.com/tls/activations?page%5Bnumber%5D=1&page%5Bsize%5D=100\"},\"meta\":{\"per_page\":100,\"current_page\":1,\"record_count\":1,\"total_pages\":1}}","originalRequest":{"name":"List TLS activations","description":"List all TLS activations.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/tls/activations?include=tls_certificate%2Ctls_configuration%2Ctls_domain&page%5Bnumber%5D=1&page%5Bsize%5D=20","path":["tls","activations?include=tls_certificate%2Ctls_configuration%2Ctls_domain&page%5Bnumber%5D=1&page%5Bsize%5D=20"],"host":["https://api.fastly.com"],"query":[{"key":"filter[tls_certificate.id]","description":"Limit the returned activations to a specific certificate."},{"key":"filter[tls_configuration.id]","description":"Limit the returned activations to a specific TLS configuration."},{"key":"filter[tls_domain.id]","description":"Limit the returned rules to a specific domain name."},{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: tls_certificate, tls_configuration, and tls_domain."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Enable TLS for a domain using a custom certificate","request":{"name":"Enable TLS for a domain using a custom certificate","description":"Enable TLS for a particular TLS domain and certificate combination. These relationships must be specified to create the TLS activation.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/tls/activations","path":["tls","activations"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_activation\",\"relationships\":{\"tls_certificate\":{\"data\":{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_certificate\"}},\"tls_configuration\":{\"data\":{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\"}},\"tls_domain\":{\"data\":{\"id\":\"example.com\",\"type\":\"tls_domain\"}}}}}"}},"response":[{"status":"201 Created","name":"201 Created","code":201,"header":[],"body":"{\"data\":{\"id\":\"aCtguUGZzb2W9Euo4moOR\",\"type\":\"tls_activation\",\"attributes\":{\"created_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"tls_certificate\":{\"data\":{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_certificate\"}},\"tls_configuration\":{\"data\":{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\"}},\"tls_domain\":{\"data\":{\"id\":\"example.com\",\"type\":\"tls_domain\"}}}}}","originalRequest":{"name":"Enable TLS for a domain using a custom certificate","description":"Enable TLS for a particular TLS domain and certificate combination. These relationships must be specified to create the TLS activation.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/tls/activations","path":["tls","activations"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_activation\",\"relationships\":{\"tls_certificate\":{\"data\":{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_certificate\"}},\"tls_configuration\":{\"data\":{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\"}},\"tls_domain\":{\"data\":{\"id\":\"example.com\",\"type\":\"tls_domain\"}}}}}"}}}]},{"name":"Get a TLS activation","request":{"name":"Get a TLS activation","description":"Show a TLS activation.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/tls/activations/{{tls_activation_id}}","path":["tls","activations","{{tls_activation_id}}"],"host":["{{fastly_url}}"],"query":[{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: tls_certificate, tls_configuration, and tls_domain."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"aCtguUGZzb2W9Euo4moOR\",\"type\":\"tls_activation\",\"attributes\":{\"created_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"tls_certificate\":{\"data\":{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_certificate\"}},\"tls_configuration\":{\"data\":{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\"}},\"tls_domain\":{\"data\":{\"id\":\"example.com\",\"type\":\"tls_domain\"}}}}}","originalRequest":{"name":"Get a TLS activation","description":"Show a TLS activation.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/tls/activations/aCtguUGZzb2W9Euo4moOR?include=tls_certificate%2Ctls_configuration%2Ctls_domain","path":["tls","activations","aCtguUGZzb2W9Euo4moOR?include=tls_certificate%2Ctls_configuration%2Ctls_domain"],"host":["https://api.fastly.com"],"query":[{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: tls_certificate, tls_configuration, and tls_domain."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Disable TLS on a domain","request":{"name":"Disable TLS on a domain","description":"Disable TLS on the domain associated with this TLS activation.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/tls/activations/{{tls_activation_id}}","path":["tls","activations","{{tls_activation_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"204 No Content","name":"204 No Content","code":204,"header":[],"originalRequest":{"name":"Disable TLS on a domain","description":"Disable TLS on the domain associated with this TLS activation.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/tls/activations/aCtguUGZzb2W9Euo4moOR","path":["tls","activations","aCtguUGZzb2W9Euo4moOR"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a certificate","request":{"name":"Update a certificate","description":"Update the certificate used to terminate TLS traffic for the domain associated with this TLS activation.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/tls/activations/{{tls_activation_id}}","path":["tls","activations","{{tls_activation_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_activation\",\"relationships\":{\"tls_certificate\":{\"data\":{\"type\":\"tls_certificate\",\"id\":\"cRTguUGZzb2W9Euo4moOr\"}}}}}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"aCtguUGZzb2W9Euo4moOR\",\"type\":\"tls_activation\",\"attributes\":{\"created_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"tls_certificate\":{\"data\":{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_certificate\"}},\"tls_configuration\":{\"data\":{\"id\":\"t7CguUGZzb2W9Euo5FoKa\",\"type\":\"tls_configuration\"}},\"tls_domain\":{\"data\":{\"id\":\"example.com\",\"type\":\"tls_domain\"}}}}}","originalRequest":{"name":"Update a certificate","description":"Update the certificate used to terminate TLS traffic for the domain associated with this TLS activation.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/tls/activations/aCtguUGZzb2W9Euo4moOR","path":["tls","activations","aCtguUGZzb2W9Euo4moOR"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_activation\",\"relationships\":{\"tls_certificate\":{\"data\":{\"type\":\"tls_certificate\",\"id\":\"cRTguUGZzb2W9Euo4moOr\"}}}}}"}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"TLS Certificates","description":"A TLS certificate is used to terminate TLS traffic for one or more of your TLS domains.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| cert_blob | string | The PEM-formatted certificate blob. Required. |\n| name | string | A customizable name for your certificate. Defaults to the certificate's Common Name or first Subject Alternative Names (SAN) entry. Optional. |\n| relationships.tls_domains.id | string | The domain name. |\n| type | string | Resource type. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying a TLS certificate. |\n| issued_to | string | The hostname for which a certificate was issued. |\n| issuer | string | The certificate authority that issued the certificate. |\n| not_after | string | Time-stamp (GMT) when the certificate will expire. Must be in the future to be used to terminate TLS traffic. |\n| not_before | string | Time-stamp (GMT) when the certificate will become valid. Must be in the past to be used to terminate TLS traffic. |\n| replace | boolean | A recommendation from Fastly indicating the key associated with this certificate is in need of rotation. |\n| serial_number | string | A value assigned by the issuer that is unique to a certificate. |\n| signature_algorithm | string | The algorithm used to sign the certificate. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"List TLS certificates","request":{"name":"List TLS certificates","description":"List all TLS certificates.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/tls/certificates","path":["tls","certificates"],"host":["{{fastly_url}}"],"query":[{"key":"filter[not_after]","description":"Limit the returned certificates to those that expire prior to the specified date in UTC. Accepts parameters: lte (e.g., filter[not_after][lte]=2020-05-05)."},{"key":"filter[tls_domains.id]","description":"Limit the returned certificates to those that include the specific domain."},{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: tls_activations."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."},{"key":"sort","description":"The order in which to list the results by creation date."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_certificate\",\"attributes\":{\"created_at\":\"2020-02-01T12:12:12.000Z\",\"issued_to\":\"...\",\"issuer\":\"Let's Encrypt Authority X3\",\"name\":\"My certificate\",\"not_after\":\"2020-02-01T12:12:12.000Z\",\"not_before\":\"2020-02-01T12:12:12.000Z\",\"replace\":false,\"serial_number\":\"1234567890\",\"signature_algorithm\":\"SHA256\",\"updated_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"tls_domains\":{\"data\":[{\"id\":\"DOMAIN_NAME\",\"type\":\"tls_domain\"}]}}}],\"links\":{\"self\":\"https://api.fastly.com/tls/certificates?page%5Bnumber%5D=1&page%5Bsize%5D=20\",\"first\":\"https://api.fastly.com/tls/certificates?page%5Bnumber%5D=1&page%5Bsize%5D=20\",\"prev\":null,\"next\":null,\"last\":\"https://api.fastly.com/tls/certificates?page%5Bnumber%5D=1&page%5Bsize%5D=20\"},\"meta\":{\"per_page\":20,\"current_page\":1,\"record_count\":1,\"total_pages\":1}}","originalRequest":{"name":"List TLS certificates","description":"List all TLS certificates.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/tls/certificates?page%5Bnumber%5D=1&page%5Bsize%5D=20&sort=created_at","path":["tls","certificates?page%5Bnumber%5D=1&page%5Bsize%5D=20&sort=created_at"],"host":["https://api.fastly.com"],"query":[{"key":"filter[not_after]","description":"Limit the returned certificates to those that expire prior to the specified date in UTC. Accepts parameters: lte (e.g., filter[not_after][lte]=2020-05-05)."},{"key":"filter[tls_domains.id]","description":"Limit the returned certificates to those that include the specific domain."},{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: tls_activations."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."},{"key":"sort","description":"The order in which to list the results by creation date."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a TLS certificate","request":{"name":"Create a TLS certificate","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/tls/custom-certs/certificates/#create-tls-cert)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/tls/certificates","path":["tls","certificates"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_certificate\",\"attributes\":{\"cert_blob\":\"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n\",\"name\":\"My certificate\"}}}"}},"response":[{"status":"201 Created","name":"201 Created","code":201,"header":[],"body":"{\"data\":{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_certificate\",\"attributes\":{\"created_at\":\"2020-02-01T12:12:12.000Z\",\"issued_to\":\"...\",\"issuer\":\"Let's Encrypt Authority X3\",\"name\":\"My certificate\",\"not_after\":\"2020-02-01T12:12:12.000Z\",\"not_before\":\"2020-02-01T12:12:12.000Z\",\"replace\":false,\"serial_number\":\"1234567890\",\"signature_algorithm\":\"SHA256\",\"updated_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"tls_domains\":{\"data\":[{\"id\":\"DOMAIN_NAME\",\"type\":\"tls_domain\"}]}}}}","originalRequest":{"name":"Create a TLS certificate","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/tls/custom-certs/certificates/#create-tls-cert)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/tls/certificates","path":["tls","certificates"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_certificate\",\"attributes\":{\"cert_blob\":\"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n\",\"name\":\"My certificate\"}}}"}}}]},{"name":"Get a TLS certificate","request":{"name":"Get a TLS certificate","description":"Show a TLS certificate.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/tls/certificates/{{tls_certificate_id}}","path":["tls","certificates","{{tls_certificate_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_certificate\",\"attributes\":{\"created_at\":\"2020-02-01T12:12:12.000Z\",\"issued_to\":\"...\",\"issuer\":\"Let's Encrypt Authority X3\",\"name\":\"My certificate\",\"not_after\":\"2020-02-01T12:12:12.000Z\",\"not_before\":\"2020-02-01T12:12:12.000Z\",\"replace\":false,\"serial_number\":\"1234567890\",\"signature_algorithm\":\"SHA256\",\"updated_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"tls_domains\":{\"data\":[{\"id\":\"DOMAIN_NAME\",\"type\":\"tls_domain\"}]}}}}","originalRequest":{"name":"Get a TLS certificate","description":"Show a TLS certificate.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/tls/certificates/cRTguUGZzb2W9Euo4moOr","path":["tls","certificates","cRTguUGZzb2W9Euo4moOr"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Delete a TLS certificate","request":{"name":"Delete a TLS certificate","description":"Destroy a TLS certificate. TLS certificates already enabled for a domain cannot be destroyed.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/tls/certificates/{{tls_certificate_id}}","path":["tls","certificates","{{tls_certificate_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"204 No Content","name":"204 No Content","code":204,"header":[],"originalRequest":{"name":"Delete a TLS certificate","description":"Destroy a TLS certificate. TLS certificates already enabled for a domain cannot be destroyed.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/tls/certificates/cRTguUGZzb2W9Euo4moOr","path":["tls","certificates","cRTguUGZzb2W9Euo4moOr"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Update a TLS certificate","request":{"name":"Update a TLS certificate","description":"Replace a TLS certificate with a newly reissued TLS certificate, or update a TLS certificate's name. If replacing a TLS certificate, the new TLS certificate must contain all SAN entries as the current TLS certificate. It must either have an exact matching list or contain a superset.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"{{fastly_url}}/tls/certificates/{{tls_certificate_id}}","path":["tls","certificates","{{tls_certificate_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_certificate\",\"attributes\":{\"cert_blob\":\"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n\",\"name\":\"My certificate\"}}}"}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_certificate\",\"attributes\":{\"created_at\":\"2020-02-01T12:12:12.000Z\",\"issued_to\":\"...\",\"issuer\":\"Let's Encrypt Authority X3\",\"name\":\"My certificate\",\"not_after\":\"2020-02-01T12:12:12.000Z\",\"not_before\":\"2020-02-01T12:12:12.000Z\",\"replace\":false,\"serial_number\":\"1234567890\",\"signature_algorithm\":\"SHA256\",\"updated_at\":\"2020-02-01T12:12:12.000Z\"},\"relationships\":{\"tls_domains\":{\"data\":[{\"id\":\"DOMAIN_NAME\",\"type\":\"tls_domain\"}]}}}}","originalRequest":{"name":"Update a TLS certificate","description":"Replace a TLS certificate with a newly reissued TLS certificate, or update a TLS certificate's name. If replacing a TLS certificate, the new TLS certificate must contain all SAN entries as the current TLS certificate. It must either have an exact matching list or contain a superset.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"PATCH","url":{"raw":"https://api.fastly.com/tls/certificates/cRTguUGZzb2W9Euo4moOr","path":["tls","certificates","cRTguUGZzb2W9Euo4moOr"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_certificate\",\"attributes\":{\"cert_blob\":\"-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n\",\"name\":\"My certificate\"}}}"}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"TLS Domains","description":"TLS domains are all the domains (including wildcard domains) included in any TLS certificate 's Subject Alternative Names (SAN) list. Included in the response is information about which certificates reference this domain as well as the TLS activation indicating which certificate is enabled to serve TLS traffic for the domain.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| id | string | The domain name. |\n| relationships.tls_activations.id | string | Alphanumeric string identifying a TLS activation. |\n| relationships.tls_certificates.id | string | Alphanumeric string identifying a TLS certificate. |\n| relationships.tls_subscriptions.id | string | Alphanumeric string identifying a TLS subscription. |\n| type | string | Resource type. |","item":[{"name":"List TLS domains","request":{"name":"List TLS domains","description":"List all TLS domains.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/tls/domains","path":["tls","domains"],"host":["{{fastly_url}}"],"query":[{"key":"filter[in_use]","description":"Optional. Limit the returned domains to those currently using Fastly to terminate TLS with SNI (that is, domains considered \"in use\") Permitted values: true, false."},{"key":"filter[tls_certificates.id]","description":"Optional. Limit the returned domains to those listed in the given TLS certificate's SAN list."},{"key":"filter[tls_subscriptions.id]","description":"Optional. Limit the returned domains to those for a given TLS subscription."},{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: tls_activations, tls_certificates, tls_subscriptions, tls_subscriptions.tls_authorizations, and tls_authorizations.globalsign_email_challenge."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."},{"key":"sort","description":"The order in which to list the results by creation date."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"DOMAIN_NAME\",\"type\":\"tls_domain\",\"relationships\":{\"tls_activations\":{\"data\":[{\"id\":\"aCtguUGZzb2W9Euo4moOR\",\"type\":\"tls_activation\"}]},\"tls_certificates\":{\"data\":[{\"id\":\"cRTguUGZzb2W9Euo4moOr\",\"type\":\"tls_certificate\"}]},\"tls_subscriptions\":{\"data\":[{\"id\":\"sU3guUGZzb2W9Euo4Mo0r\",\"type\":\"tls_subscription\"}]}}}],\"links\":{\"self\":\"https://api.fastly.com/tls/domains?page%5Bnumber%5D=1&page%5Bsize%5D=20\",\"first\":\"https://api.fastly.com/tls/domains?page%5Bnumber%5D=1&page%5Bsize%5D=20\",\"last\":\"https://api.fastly.com/tls/domains?page%5Bnumber%5D=1&page%5Bsize%5D=20\"},\"meta\":{\"record_count\":1,\"current_page\":1,\"per_page\":20,\"total_pages\":1}}","originalRequest":{"name":"List TLS domains","description":"List all TLS domains.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/tls/domains?page%5Bnumber%5D=1&page%5Bsize%5D=20&sort=created_at","path":["tls","domains?page%5Bnumber%5D=1&page%5Bsize%5D=20&sort=created_at"],"host":["https://api.fastly.com"],"query":[{"key":"filter[in_use]","description":"Optional. Limit the returned domains to those currently using Fastly to terminate TLS with SNI (that is, domains considered \"in use\") Permitted values: true, false."},{"key":"filter[tls_certificates.id]","description":"Optional. Limit the returned domains to those listed in the given TLS certificate's SAN list."},{"key":"filter[tls_subscriptions.id]","description":"Optional. Limit the returned domains to those for a given TLS subscription."},{"key":"include","description":"Include related objects. Optional, comma-separated values. Permitted values: tls_activations, tls_certificates, tls_subscriptions, tls_subscriptions.tls_authorizations, and tls_authorizations.globalsign_email_challenge."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."},{"key":"sort","description":"The order in which to list the results by creation date."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Private Keys","description":"A private key is used to sign a Certificate. A key can be used to sign multiple certificates.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| key | string | The contents of the private key. Must be a PEM-formatted key. Not returned in response body. Required. |\n| name | string | A customizable name for your private key. Optional. |\n| relationships.tls_activations.id | string | Alphanumeric string identifying a TLS activation. |\n| relationships.tls_domains.id | string | The domain name. |\n| type | string | Resource type. |\n| created_at | string | Date and time in ISO 8601 format. |\n| deleted_at | string | Date and time in ISO 8601 format. |\n| id | string | Alphanumeric string identifying a private Key. |\n| key_length | integer | The key length used to generate the private key. |\n| key_type | string | The algorithm used to generate the private key. Must be RSA. |\n| public_key_sha1 | string | Useful for safely identifying the key. |\n| replace | boolean | A recommendation from Fastly to replace this private key and all associated certificates. |\n| updated_at | string | Date and time in ISO 8601 format. |","item":[{"name":"List TLS private keys","request":{"name":"List TLS private keys","description":"List all TLS private keys.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/tls/private_keys","path":["tls","private_keys"],"host":["{{fastly_url}}"],"query":[{"key":"filter[in_use]","description":"Limit the returned keys to those without any matching TLS certificates. The only valid value is false."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":[{\"id\":\"KeYguUGZzb2W9Euo4moOR\",\"type\":\"tls_private_key\",\"attributes\":{\"key_length\":2048,\"key_type\":\"RSA\",\"name\":\"My private key\",\"created_at\":\"2020-02-01T12:12:12.000Z\",\"replace\":false,\"public_key_sha1\":\"KEY_DIGEST\"}}],\"meta\":{\"record_count\":1,\"current_page\":1,\"per_page\":20,\"total_pages\":1}}","originalRequest":{"name":"List TLS private keys","description":"List all TLS private keys.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/tls/private_keys?page%5Bnumber%5D=1&page%5Bsize%5D=20","path":["tls","private_keys?page%5Bnumber%5D=1&page%5Bsize%5D=20"],"host":["https://api.fastly.com"],"query":[{"key":"filter[in_use]","description":"Limit the returned keys to those without any matching TLS certificates. The only valid value is false."},{"key":"page[number]","description":"Current page."},{"key":"page[size]","description":"Number of records per page."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Create a TLS private key","request":{"name":"Create a TLS private key","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/tls/custom-certs/private-keys/#create-tls-key)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"{{fastly_url}}/tls/private_keys","path":["tls","private_keys"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_private_key\",\"attributes\":{\"key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"name\":\"My private key\"}}}"}},"response":[{"status":"201 Created","name":"201 Created","code":201,"header":[],"body":"{\"data\":{\"id\":\"KeYguUGZzb2W9Euo4moOR\",\"type\":\"tls_private_key\",\"attributes\":{\"key_length\":2048,\"key_type\":\"RSA\",\"name\":\"My private key\",\"created_at\":null,\"replace\":false,\"public_key_sha1\":\"KEY_DIGEST\"}}}","originalRequest":{"name":"Create a TLS private key","description":"**[🔗 latest documentation](https://developer.fastly.com/reference/api/tls/custom-certs/private-keys/#create-tls-key)**\n\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"POST","url":{"raw":"https://api.fastly.com/tls/private_keys","path":["tls","private_keys"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Content-Type","value":"application/vnd.api+json"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]},"body":{"mode":"raw","raw":"{\"data\":{\"type\":\"tls_private_key\",\"attributes\":{\"key\":\"-----BEGIN PRIVATE KEY-----\\n...\\n-----END PRIVATE KEY-----\\n\",\"name\":\"My private key\"}}}"}}}]},{"name":"Get a TLS private key","request":{"name":"Get a TLS private key","description":"Show a TLS private key.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"{{fastly_url}}/tls/private_keys/{{tls_private_key_id}}","path":["tls","private_keys","{{tls_private_key_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"data\":{\"id\":\"KeYguUGZzb2W9Euo4moOR\",\"type\":\"tls_private_key\",\"attributes\":{\"key_length\":2048,\"key_type\":\"RSA\",\"name\":\"My private key\",\"created_at\":\"2020-02-01T12:12:12.000Z\",\"replace\":false,\"public_key_sha1\":\"KEY_DIGEST\"}}}","originalRequest":{"name":"Get a TLS private key","description":"Show a TLS private key.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"GET","url":{"raw":"https://api.fastly.com/tls/private_keys/KeYguUGZzb2W9Euo4moOR","path":["tls","private_keys","KeYguUGZzb2W9Euo4moOR"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/vnd.api+json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]},{"name":"Delete a TLS private key","request":{"name":"Delete a TLS private key","description":"Destroy a TLS private key. Only private keys not already matched to any certificates can be deleted.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"{{fastly_url}}/tls/private_keys/{{tls_private_key_id}}","path":["tls","private_keys","{{tls_private_key_id}}"],"host":["{{fastly_url}}"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"204 No Content","name":"204 No Content","code":204,"header":[],"originalRequest":{"name":"Delete a TLS private key","description":"Destroy a TLS private key. Only private keys not already matched to any certificates can be deleted.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [TLS management](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions.\n","method":"DELETE","url":{"raw":"https://api.fastly.com/tls/private_keys/KeYguUGZzb2W9Euo4moOR","path":["tls","private_keys","KeYguUGZzb2W9Euo4moOR"],"host":["https://api.fastly.com"],"query":[]},"header":[{"key":"Host","value":"api.fastly.com"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}]}]},{"name":"Utilities","item":[{"name":"Check content status","description":"Fastly makes it possible to see which version of a particular URL is cached on each edge server.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions (this endpoint does not accept a token with the `global:read` scope).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n","item":[{"name":"Check status of content in each POP's cache","request":{"name":"Check status of content in each POP's cache","description":"Retrieve headers and MD5 hash of the content for a particular URL from each Fastly edge server. This API is limited to 200 requests per hour.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions (this endpoint does not accept a token with the `global:read` scope).\n","method":"GET","url":{"raw":"{{fastly_url}}/content/edge_check","path":["content","edge_check"],"host":["{{fastly_url}}"],"query":[{"key":"url","description":"Full URL (host and path) to check on all nodes. if protocol is omitted, http will be assumed."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"[{\"hash\":\"c6447943be2cff04787d9367ddd58fa0\",\"request\":{\"headers\":{\"Host\":\"www.example.com/foo/bar\",\"User-Agent\":\"Fastly/cache-check\"},\"method\":null,\"url\":null},\"response\":{\"headers\":{\"Accept-Ranges\":\"bytes\",\"Age\":\"0\",\"Connection\":\"keep-alive\",\"Content-Length\":\"154189\",\"Content-Type\":\"text/html; charset=UTF-8\",\"Date\":\"Mon, 06 Jun 2016 15:26:05 GMT\",\"ETag\":\"W/\\\"76cdf069e25c5e32bb8005982d3f8e0d\\\"\",\"Expires\":\"Thu, 01 Jan 1970 00:00:00 GMT\",\"Set-Cookie\":[\"crumb=EUmnHJvt3XCJP2hZmlzWCvVNzOHq5Wb1;Path=/\",\"SS_MID=7b22de59-a0ca-4d2f-aea2-dbe337990ba3ip466npy;Path=/;Domain=.example.com;Expires=Thu, 04-Jun-2026 15:26:05 GMT\"],\"Vary\":\"Accept-Encoding, User-Agent\",\"Via\":\"1.1 varnish\",\"X-Cache\":\"MISS\",\"X-Cache-Hits\":\"0\",\"X-ContextId\":\"P0IlaNKm/roP4a7jq\",\"X-PC-AppVer\":\"7951\",\"X-PC-Date\":\"Mon, 06 Jun 2016 15:26:04 GMT\",\"X-PC-Hit\":\"true\",\"X-PC-Host\":\"127.0.0.1\",\"X-PC-Key\":\"OZs6DMRDuX2Tj7xXJlbWIZgI2cI-example\",\"X-Served-By\":\"cache-sjc3120-SJC\",\"X-ServedBy\":\"web029\",\"X-Timer\":\"S1465226764.194256,VS0,VE1054\",\"X-Via\":\"1.1 echo007\"},\"status\":200},\"response_time\":2.604431,\"server\":\"cache-sjc3120\",\"pop\":\"SJC\"}]","originalRequest":{"name":"Check status of content in each POP's cache","description":"Retrieve headers and MD5 hash of the content for a particular URL from each Fastly edge server. This API is limited to 200 requests per hour.\n> **Authorization**: [API token](/reference/api/auth-tokens) with at least [Engineer](https://docs.fastly.com/en/guides/configuring-user-roles-and-permissions\") permissions (this endpoint does not accept a token with the `global:read` scope).\n","method":"GET","url":{"raw":"https://api.fastly.com/content/edge_check?url=https%3A%2F%2Fwww.example.com%2Ffoo%2Fbar","path":["content","edge_check?url=https%3A%2F%2Fwww.example.com%2Ffoo%2Fbar"],"host":["https://api.fastly.com"],"query":[{"key":"url","description":"Full URL (host and path) to check on all nodes. if protocol is omitted, http will be assumed."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}}}]}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},{"name":"Diff","description":"See the line-by-line changes in configuration between two different versions of a service.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n\n## Data model\n| Name | Type | Description |\n| --- | --- | --- |\n| diff | string | The differences between two specified service versions. Returns the full config if the version configurations are identical. |\n| format | string | The format the diff is being returned in ( text, html or html_simple). |\n| from | integer | The version number being diffed from. |\n| to | integer | The version number being diffed to. |","item":[{"name":"Diff two service versions","request":{"name":"Diff two service versions","description":"Get diff between two versions.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"{{fastly_url}}/service/{{service_id}}/diff/from/{{from_version_id}}/to/{{to_version_id}}","path":["service","{{service_id}}","diff","from","{{from_version_id}}","to","{{to_version_id}}"],"host":["{{fastly_url}}"],"query":[{"key":"format","description":"Optional method to format the diff field."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept","value":"application/json"}],"auth":{"type":"apikey","apikey":[{"key":"value","value":"{{fastly_key}}","type":"string"},{"key":"key","value":"Fastly-Key","type":"string"}]}},"response":[{"status":"200 OK","name":"200 OK","code":200,"header":[],"body":"{\"from\":1,\"to\":2,\"format\":\"text\",\"diff\":\"backends:\\n- name: My Backend\\n  address: backend.example.com\\n  auto_loadbalance: '0'\\n  between_bytes_timeout: 10000\\n  client_cert:\\n  comment: ''\\n  connect_timeout: 1000\\n  first_byte_timeout: 15000\\n  healthcheck:\\n  hostname: www.example.com\\n  ipv4:\\n  ipv6:\\n  max_conn: 200\\n  port: 80\\n  request_condition: ''\\n  shield:\\n  ssl_ca_cert:\\n  ssl_client_cert:\\n  ssl_client_key:\\n  ssl_hostname:\\n  use_ssl: false\\n  weight: 100\\ncache_settings: []\\ncomment: ''\\nconditions: []\\ndeployed:\\ndirectors: []\\ndomains:\\n- name: www.example.com\\n  comment: ''\\ngzips: []\\n-headers: []\\n+headers:\\n+- name: Debug\\n+  action: set\\n+  cache_condition:\\n+  dst: http.X-Test\\n+  ignore_if_set: '0'\\n+  priority: '10'\\n+  regex: ''\\n+  request_condition:\\n+  response_condition:\\n+  src: '\\\"testing\\\"'\\n+  substitution: ''\\n+  type: request\\nhealthchecks: []\\norigins: []\\nrequest_settings: []\\nresponse_objects: []\\nservice_id: SU1Z0isxPaozGVKXdv0eY\\nsettings:\\n  general.default_host: ''\\n  general.default_ttl: 3600\\nsnippets: []\\nstaging:\\nsyslogs: []\\ntesting:\\nvcls: []\\nwordpress: []\\n\"}","originalRequest":{"name":"Diff two service versions","description":"Get diff between two versions.\n> **Authorization**: Requires [API token](/reference/api/auth-tokens).\n","method":"GET","url":{"raw":"https://api.fastly.com/service/SU1Z0isxPaozGVKXdv0eY/diff/from/1/to/2","path":["service","SU1Z0isxPaozGVKXdv0eY","diff","from","1","to","2"],"host":["https://api.fastly.com"],"query":[{"key":"format","description":"Optional method to format the diff field."}]},"header":[{"key":"Host","value":"api.fastly.com"},{"key":"Accept",