Get all account providers
Returns the list of account providers of an account.
Authorizations:
Responses
Response samples
- 200
[- {
- "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
- "commitment_gb_per_month": 0,
- "enable_commitment": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "provider": 0,
- "provider_details": {
- "id": 0,
- "name": "string"
}, - "service_uids": "string"
}
]
Create a new account provider
Adds a new account provider to an account.
Authorizations:
Request Body schema: application/json
commitment_gb_per_month | number or null <double> >= 0 |
enable_commitment | boolean |
provider required | integer |
Responses
Request samples
- Payload
{- "commitment_gb_per_month": 0,
- "enable_commitment": true,
- "provider": 0
}
Response samples
- 201
{- "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
- "commitment_gb_per_month": 0,
- "enable_commitment": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "provider": 0,
- "provider_details": {
- "id": 0,
- "name": "string"
}, - "service_uids": "string"
}
Retrieve an account provider
Gets a specific account provider.
Authorizations:
path Parameters
id required | string <uuid> |
Responses
Response samples
- 200
{- "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
- "commitment_gb_per_month": 0,
- "enable_commitment": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "provider": 0,
- "provider_details": {
- "id": 0,
- "name": "string"
}, - "service_uids": "string"
}
Update an existing account provider
Updates an existing account provider of an account.
Authorizations:
path Parameters
id required | string <uuid> |
Request Body schema: application/json
commitment_gb_per_month | number or null <double> >= 0 |
enable_commitment | boolean |
provider required | integer |
Responses
Request samples
- Payload
{- "commitment_gb_per_month": 0,
- "enable_commitment": true,
- "provider": 0
}
Response samples
- 200
{- "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
- "commitment_gb_per_month": 0,
- "enable_commitment": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "provider": 0,
- "provider_details": {
- "id": 0,
- "name": "string"
}, - "service_uids": "string"
}
Get all certificates
Returns the list of certificates of an account.
Authorizations:
Responses
Response samples
- 200
[- {
- "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
- "challenges": "string",
- "cn": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "not_valid_after": "2019-08-24T14:15:22Z",
- "providers_certificates": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "not_valid_after": "2019-08-24T14:15:22Z",
- "provider": "017a51ba-65fb-4bca-a631-012d4d8d49b9",
- "provider_certificate_id": "string",
- "provider_name": "string"
}
], - "status": "string",
- "type": "string"
}
]
Create a new certificate
Adds a new certificate to an account.
Authorizations:
Request Body schema: application/json
cn | string <= 8192 characters |
name required | string <= 255 characters |
not_valid_after | string or null <date-time> |
Array of objects (ProviderCertificate) | |
type | string <= 255 characters |
Responses
Request samples
- Payload
{- "cn": "string",
- "name": "string",
- "not_valid_after": "2019-08-24T14:15:22Z",
- "providers_certificates": [
- {
- "not_valid_after": "2019-08-24T14:15:22Z",
- "provider": "017a51ba-65fb-4bca-a631-012d4d8d49b9",
- "provider_certificate_id": "string"
}
], - "type": "string"
}
Response samples
- 201
{- "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
- "challenges": "string",
- "cn": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "not_valid_after": "2019-08-24T14:15:22Z",
- "providers_certificates": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "not_valid_after": "2019-08-24T14:15:22Z",
- "provider": "017a51ba-65fb-4bca-a631-012d4d8d49b9",
- "provider_certificate_id": "string",
- "provider_name": "string"
}
], - "status": "string",
- "type": "string"
}
Retrieve a certificate
Gets a specific certificate.
Authorizations:
path Parameters
id required | string <uuid> |
Responses
Response samples
- 200
{- "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
- "challenges": "string",
- "cn": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "not_valid_after": "2019-08-24T14:15:22Z",
- "providers_certificates": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "not_valid_after": "2019-08-24T14:15:22Z",
- "provider": "017a51ba-65fb-4bca-a631-012d4d8d49b9",
- "provider_certificate_id": "string",
- "provider_name": "string"
}
], - "status": "string",
- "type": "string"
}
Update an existing certificate
Updates an existing certificate of an account.
Authorizations:
path Parameters
id required | string <uuid> |
Request Body schema: application/json
cn | string <= 8192 characters |
name required | string <= 255 characters |
not_valid_after | string or null <date-time> |
Array of objects (ProviderCertificate) | |
type | string <= 255 characters |
Responses
Request samples
- Payload
{- "cn": "string",
- "name": "string",
- "not_valid_after": "2019-08-24T14:15:22Z",
- "providers_certificates": [
- {
- "not_valid_after": "2019-08-24T14:15:22Z",
- "provider": "017a51ba-65fb-4bca-a631-012d4d8d49b9",
- "provider_certificate_id": "string"
}
], - "type": "string"
}
Response samples
- 200
{- "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
- "challenges": "string",
- "cn": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "not_valid_after": "2019-08-24T14:15:22Z",
- "providers_certificates": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "not_valid_after": "2019-08-24T14:15:22Z",
- "provider": "017a51ba-65fb-4bca-a631-012d4d8d49b9",
- "provider_certificate_id": "string",
- "provider_name": "string"
}
], - "status": "string",
- "type": "string"
}
Get all services
Returns the list of services of an account.
Authorizations:
Responses
Response samples
- 200
[- {
- "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
- "certificate": "b7dc5fd8-9c23-4dd8-a5cb-7431da1854eb",
- "cname": "string",
- "description": "string",
- "enable_extended_statistics": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "read_only": true,
- "service_template": "DEFAULT",
- "service_uid": "string"
}
]
Create a new service
Adds a new service to an account.
Authorizations:
Request Body schema: application/json
certificate | string <uuid> |
description | string or null <= 255 characters Some useful description |
enable_extended_statistics | boolean |
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ A service name. |
(ServiceTemplateEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) |
Responses
Request samples
- Payload
{- "certificate": "b7dc5fd8-9c23-4dd8-a5cb-7431da1854eb",
- "description": "string",
- "enable_extended_statistics": true,
- "name": "string",
- "service_template": "DEFAULT"
}
Response samples
- 201
{- "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
- "certificate": "b7dc5fd8-9c23-4dd8-a5cb-7431da1854eb",
- "cname": "string",
- "description": "string",
- "enable_extended_statistics": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "read_only": true,
- "service_template": "DEFAULT",
- "service_uid": "string"
}
Retrieve a service
Gets a specific service.
Authorizations:
path Parameters
id required | string <uuid> |
Responses
Response samples
- 200
{- "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
- "certificate": "b7dc5fd8-9c23-4dd8-a5cb-7431da1854eb",
- "cname": "string",
- "description": "string",
- "enable_extended_statistics": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "read_only": true,
- "service_template": "DEFAULT",
- "service_uid": "string"
}
Update an existing service
Updates an existing service of an account.
Authorizations:
path Parameters
id required | string <uuid> |
Request Body schema: application/json
description | string or null <= 255 characters Some useful description |
Responses
Request samples
- Payload
{- "description": "string"
}
Response samples
- 200
{- "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
- "certificate": "b7dc5fd8-9c23-4dd8-a5cb-7431da1854eb",
- "cname": "string",
- "description": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "read_only": true,
- "service_uid": "string"
}
Provider Exists
Check if given CDN provider already has a service matching given domain
Authorizations:
path Parameters
id required | string |
query Parameters
account_provider_id required | string <uuid> Account provider ID |
Responses
Response samples
- 200
{- "exists": true,
- "service_name": "string"
}
services_modify_extended_stats_update
Authorizations:
path Parameters
id required | string |
Request Body schema: application/json
certificate | string <uuid> |
description | string or null <= 255 characters Some useful description |
enable_extended_statistics | boolean |
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ A service name. |
(ServiceTemplateEnum (string or null)) or (BlankEnum (any or null)) or (NullEnum (any or null)) |
Responses
Request samples
- Payload
{- "certificate": "b7dc5fd8-9c23-4dd8-a5cb-7431da1854eb",
- "description": "string",
- "enable_extended_statistics": true,
- "name": "string",
- "service_template": "DEFAULT"
}
Response samples
- 200
{- "account": "f5b54a51-a98c-44cf-bb68-a676332e7d12",
- "certificate": "b7dc5fd8-9c23-4dd8-a5cb-7431da1854eb",
- "cname": "string",
- "description": "string",
- "enable_extended_statistics": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "read_only": true,
- "service_template": "DEFAULT",
- "service_uid": "string"
}
Get all behaviors
Returns the list of behaviors of a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Responses
Response samples
- 200
[- {
- "behavior_actions": [
- {
- "allowed_methods": "string",
- "auto_minify": "string",
- "cache_behavior_value": "string",
- "cache_key": "string",
- "cached_methods": "string",
- "client_header_name": "string",
- "cookie": "string",
- "enabled": true,
- "host_header": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "max_ttl": -2147483648,
- "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "origin_cache_control_enabled": true,
- "pattern": "string",
- "response_header_name": "string",
- "response_header_value": "string",
- "response_page_path": "string",
- "status_code": -2147483648,
- "type": "string",
- "unified_log_destination": "6b9e43d0-efb6-40cf-a877-1ecd22857a43",
- "unified_log_sampling_rate": -2147483648
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_default": true,
- "name": "string",
- "path_pattern": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
]
Create a new behavior
Adds a new behavior to a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Request Body schema: application/json
required | Array of objects (BehaviorAction) |
is_default | boolean |
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ |
path_pattern required | string <= 1024 characters |
service required | string <uuid> |
Responses
Request samples
- Payload
{- "behavior_actions": [
- {
- "allowed_methods": "string",
- "auto_minify": "string",
- "cache_behavior_value": "string",
- "cache_key": "string",
- "cached_methods": "string",
- "client_header_name": "string",
- "cookie": "string",
- "enabled": true,
- "host_header": "string",
- "max_ttl": -2147483648,
- "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "origin_cache_control_enabled": true,
- "pattern": "string",
- "response_header_name": "string",
- "response_header_value": "string",
- "response_page_path": "string",
- "status_code": -2147483648,
- "type": "string",
- "unified_log_destination": "6b9e43d0-efb6-40cf-a877-1ecd22857a43",
- "unified_log_sampling_rate": -2147483648
}
], - "is_default": true,
- "name": "string",
- "path_pattern": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Response samples
- 201
{- "behavior_actions": [
- {
- "allowed_methods": "string",
- "auto_minify": "string",
- "cache_behavior_value": "string",
- "cache_key": "string",
- "cached_methods": "string",
- "client_header_name": "string",
- "cookie": "string",
- "enabled": true,
- "host_header": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "max_ttl": -2147483648,
- "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "origin_cache_control_enabled": true,
- "pattern": "string",
- "response_header_name": "string",
- "response_header_value": "string",
- "response_page_path": "string",
- "status_code": -2147483648,
- "type": "string",
- "unified_log_destination": "6b9e43d0-efb6-40cf-a877-1ecd22857a43",
- "unified_log_sampling_rate": -2147483648
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_default": true,
- "name": "string",
- "path_pattern": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Reset default behavior
Reset default behavior
Authorizations:
path Parameters
service_id required | string |
Request Body schema: application/json
required | Array of objects (BehaviorAction) |
is_default | boolean |
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ |
path_pattern required | string <= 1024 characters |
service required | string <uuid> |
Responses
Request samples
- Payload
{- "behavior_actions": [
- {
- "allowed_methods": "string",
- "auto_minify": "string",
- "cache_behavior_value": "string",
- "cache_key": "string",
- "cached_methods": "string",
- "client_header_name": "string",
- "cookie": "string",
- "enabled": true,
- "host_header": "string",
- "max_ttl": -2147483648,
- "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "origin_cache_control_enabled": true,
- "pattern": "string",
- "response_header_name": "string",
- "response_header_value": "string",
- "response_page_path": "string",
- "status_code": -2147483648,
- "type": "string",
- "unified_log_destination": "6b9e43d0-efb6-40cf-a877-1ecd22857a43",
- "unified_log_sampling_rate": -2147483648
}
], - "is_default": true,
- "name": "string",
- "path_pattern": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Response samples
- 200
{- "behavior_actions": [
- {
- "allowed_methods": "string",
- "auto_minify": "string",
- "cache_behavior_value": "string",
- "cache_key": "string",
- "cached_methods": "string",
- "client_header_name": "string",
- "cookie": "string",
- "enabled": true,
- "host_header": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "max_ttl": -2147483648,
- "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "origin_cache_control_enabled": true,
- "pattern": "string",
- "response_header_name": "string",
- "response_header_value": "string",
- "response_page_path": "string",
- "status_code": -2147483648,
- "type": "string",
- "unified_log_destination": "6b9e43d0-efb6-40cf-a877-1ecd22857a43",
- "unified_log_sampling_rate": -2147483648
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_default": true,
- "name": "string",
- "path_pattern": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Retrieve a behavior
Gets a specific behavior.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Responses
Response samples
- 200
{- "behavior_actions": [
- {
- "allowed_methods": "string",
- "auto_minify": "string",
- "cache_behavior_value": "string",
- "cache_key": "string",
- "cached_methods": "string",
- "client_header_name": "string",
- "cookie": "string",
- "enabled": true,
- "host_header": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "max_ttl": -2147483648,
- "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "origin_cache_control_enabled": true,
- "pattern": "string",
- "response_header_name": "string",
- "response_header_value": "string",
- "response_page_path": "string",
- "status_code": -2147483648,
- "type": "string",
- "unified_log_destination": "6b9e43d0-efb6-40cf-a877-1ecd22857a43",
- "unified_log_sampling_rate": -2147483648
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_default": true,
- "name": "string",
- "path_pattern": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Update an existing behavior
Updates an existing behavior of a service.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Request Body schema: application/json
required | Array of objects (BehaviorAction) |
is_default | boolean |
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ |
path_pattern required | string <= 1024 characters |
service required | string <uuid> |
Responses
Request samples
- Payload
{- "behavior_actions": [
- {
- "allowed_methods": "string",
- "auto_minify": "string",
- "cache_behavior_value": "string",
- "cache_key": "string",
- "cached_methods": "string",
- "client_header_name": "string",
- "cookie": "string",
- "enabled": true,
- "host_header": "string",
- "max_ttl": -2147483648,
- "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "origin_cache_control_enabled": true,
- "pattern": "string",
- "response_header_name": "string",
- "response_header_value": "string",
- "response_page_path": "string",
- "status_code": -2147483648,
- "type": "string",
- "unified_log_destination": "6b9e43d0-efb6-40cf-a877-1ecd22857a43",
- "unified_log_sampling_rate": -2147483648
}
], - "is_default": true,
- "name": "string",
- "path_pattern": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Response samples
- 200
{- "behavior_actions": [
- {
- "allowed_methods": "string",
- "auto_minify": "string",
- "cache_behavior_value": "string",
- "cache_key": "string",
- "cached_methods": "string",
- "client_header_name": "string",
- "cookie": "string",
- "enabled": true,
- "host_header": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "max_ttl": -2147483648,
- "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "origin_cache_control_enabled": true,
- "pattern": "string",
- "response_header_name": "string",
- "response_header_value": "string",
- "response_page_path": "string",
- "status_code": -2147483648,
- "type": "string",
- "unified_log_destination": "6b9e43d0-efb6-40cf-a877-1ecd22857a43",
- "unified_log_sampling_rate": -2147483648
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_default": true,
- "name": "string",
- "path_pattern": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Get all compute functions
Returns the list of compute functions of a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Responses
Response samples
- 200
[- {
- "compute_routes": [
- {
- "domain": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "path": "string"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "request_code": "string",
- "response_code": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
]
Create a new compute function
Adds a new compute function to a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Request Body schema: application/json
required | Array of objects (ComputeRoute) |
name required | string <= 255 characters ^(?=[a-zA-Z_])(?=\S)([a-zA-Z]|[a-zA-Z][a-zA-Z... |
request_code | string or null <= 1048576 characters |
response_code | string or null <= 1048576 characters |
service required | string <uuid> |
Responses
Request samples
- Payload
{- "compute_routes": [
- {
- "domain": "string",
- "path": "string"
}
], - "name": "string",
- "request_code": "string",
- "response_code": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Response samples
- 201
{- "compute_routes": [
- {
- "domain": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "path": "string"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "request_code": "string",
- "response_code": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Retrieve a compute function
Gets a specific compute function.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Responses
Response samples
- 200
{- "compute_routes": [
- {
- "domain": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "path": "string"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "request_code": "string",
- "response_code": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Update an existing compute function
Updates an existing compute function of a service.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Request Body schema: application/json
required | Array of objects (ComputeRoute) |
name required | string <= 255 characters ^(?=[a-zA-Z_])(?=\S)([a-zA-Z]|[a-zA-Z][a-zA-Z... |
request_code | string or null <= 1048576 characters |
response_code | string or null <= 1048576 characters |
service required | string <uuid> |
Responses
Request samples
- Payload
{- "compute_routes": [
- {
- "domain": "string",
- "path": "string"
}
], - "name": "string",
- "request_code": "string",
- "response_code": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Response samples
- 200
{- "compute_routes": [
- {
- "domain": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "path": "string"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "request_code": "string",
- "response_code": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Get all domain mappings
Returns the list of domain mappings of a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Responses
Response samples
- 200
[- {
- "domain": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
- "load_balancer_object": "string",
- "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "origin_object": "string",
- "path_pattern": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
]
Create a new domain mapping
Adds a new domain mapping to a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Request Body schema: application/json
domain required | string <= 255 characters |
load_balancer | string or null <uuid> |
origin | string or null <uuid> |
path_pattern | string or null <= 1024 characters |
service required | string <uuid> |
Responses
Request samples
- Payload
{- "domain": "string",
- "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
- "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "path_pattern": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Response samples
- 201
{- "domain": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
- "load_balancer_object": "string",
- "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "origin_object": "string",
- "path_pattern": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Retrieve a domain mapping
Gets a specific domain mapping.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Responses
Response samples
- 200
{- "domain": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
- "load_balancer_object": "string",
- "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "origin_object": "string",
- "path_pattern": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Update an existing domain mapping
Updates an existing domain mapping of a service.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Request Body schema: application/json
domain required | string <= 255 characters |
load_balancer | string or null <uuid> |
origin | string or null <uuid> |
path_pattern | string or null <= 1024 characters |
service required | string <uuid> |
Responses
Request samples
- Payload
{- "domain": "string",
- "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
- "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "path_pattern": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Response samples
- 200
{- "domain": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
- "load_balancer_object": "string",
- "origin": "25c01b72-1ac4-4529-8608-f700e1b2b431",
- "origin_object": "string",
- "path_pattern": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Get all geo restrictions
Returns the list of geo restrictions of a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Responses
Response samples
- 200
[- {
- "countries": [
- {
- "country": "st"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "allow"
}
]
Create a new geo restriction
Adds a new geo restriction to a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Request Body schema: application/json
required | Array of objects (GeoRestrictionCountry) |
service required | string <uuid> |
type required | string (GeoRestrictionTypeEnum) Enum: "allow" "deny"
|
Responses
Request samples
- Payload
{- "countries": [
- {
- "country": "st"
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "allow"
}
Response samples
- 201
{- "countries": [
- {
- "country": "st"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "allow"
}
Retrieve a geo restriction
Gets a specific geo restriction.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Responses
Response samples
- 200
{- "countries": [
- {
- "country": "st"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "allow"
}
Update an existing geo restriction
Updates an existing geo restriction of a service.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Request Body schema: application/json
required | Array of objects (GeoRestrictionCountry) |
service required | string <uuid> |
type required | string (GeoRestrictionTypeEnum) Enum: "allow" "deny"
|
Responses
Request samples
- Payload
{- "countries": [
- {
- "country": "st"
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "allow"
}
Response samples
- 200
{- "countries": [
- {
- "country": "st"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "allow"
}
Get all health-checks
Returns the list of health-checks of a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Responses
Response samples
- 200
[- {
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "url": "string"
}
]
Create a new health-check
Adds a new health-check to a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Request Body schema: application/json
enabled | boolean |
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ |
service required | string <uuid> |
url required | string <= 1024 characters |
Responses
Request samples
- Payload
{- "enabled": true,
- "name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "url": "string"
}
Response samples
- 201
{- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "url": "string"
}
Retrieve a health-check
Gets a specific health-check.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Responses
Response samples
- 200
{- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "url": "string"
}
Update an existing health-check
Updates an existing health-check of a service.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Request Body schema: application/json
enabled | boolean |
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ |
service required | string <uuid> |
url required | string <= 1024 characters |
Responses
Request samples
- Payload
{- "enabled": true,
- "name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "url": "string"
}
Response samples
- 200
{- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "url": "string"
}
Get all load-balancers
Returns the list of load-balancers of a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Responses
Response samples
- 200
[- {
- "custom_rules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
- "matching_rule": null,
- "name": "string",
- "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
- "origin_set_name": "string",
- "priority": -9223372036854776000
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "origin_sets": [
- {
- "name": "string",
- "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
- "origins": "string",
- "weight": 255
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "weighted"
}
]
Create a new load-balancer
Adds a new load-balancer to a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Request Body schema: application/json
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ |
required | Array of objects (LoadBalancerOriginSet) |
service required | string <uuid> |
type required | string (LoadBalancerTypeEnum) Value: "weighted"
|
Responses
Request samples
- Payload
{- "name": "string",
- "origin_sets": [
- {
- "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
- "weight": 255
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "weighted"
}
Response samples
- 201
{- "custom_rules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
- "matching_rule": null,
- "name": "string",
- "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
- "origin_set_name": "string",
- "priority": -9223372036854776000
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "origin_sets": [
- {
- "name": "string",
- "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
- "origins": "string",
- "weight": 255
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "weighted"
}
Retrieve a load-balancer
Gets a specific load-balancer.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Responses
Response samples
- 200
{- "custom_rules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
- "matching_rule": null,
- "name": "string",
- "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
- "origin_set_name": "string",
- "priority": -9223372036854776000
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "origin_sets": [
- {
- "name": "string",
- "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
- "origins": "string",
- "weight": 255
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "weighted"
}
Update an existing load-balancer
Updates an existing load-balancer of a service.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Request Body schema: application/json
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ |
required | Array of objects (LoadBalancerOriginSet) |
service required | string <uuid> |
type required | string (LoadBalancerTypeEnum) Value: "weighted"
|
Responses
Request samples
- Payload
{- "name": "string",
- "origin_sets": [
- {
- "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
- "weight": 255
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "weighted"
}
Response samples
- 200
{- "custom_rules": [
- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
- "matching_rule": null,
- "name": "string",
- "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
- "origin_set_name": "string",
- "priority": -9223372036854776000
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "origin_sets": [
- {
- "name": "string",
- "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
- "origins": "string",
- "weight": 255
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "weighted"
}
Get all load-balancer custom rules
Returns the list of load-balancer custom rules of a load-balancer.
Authorizations:
path Parameters
load_balancer_id required | string |
service_id required | string |
Responses
Response samples
- 200
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
- "matching_rule": null,
- "name": "string",
- "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
- "origin_set_name": "string",
- "priority": -9223372036854776000
}
]
Create a new load-balancer custom rule
Adds a new load-balancer custom rule to a load-balancer.
Authorizations:
path Parameters
load_balancer_id required | string |
service_id required | string |
Request Body schema: application/json
load_balancer required | string <uuid> |
matching_rule required | any |
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ |
origin_set required | string <uuid> |
priority | integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ] |
Responses
Request samples
- Payload
{- "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
- "matching_rule": null,
- "name": "string",
- "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
- "priority": -9223372036854776000
}
Response samples
- 201
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
- "matching_rule": null,
- "name": "string",
- "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
- "origin_set_name": "string",
- "priority": -9223372036854776000
}
Retrieve a load-balancer custom rule
Gets a specific load-balancer custom rule.
Authorizations:
path Parameters
id required | string <uuid> |
load_balancer_id required | string |
service_id required | string |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
- "matching_rule": null,
- "name": "string",
- "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
- "origin_set_name": "string",
- "priority": -9223372036854776000
}
Update an existing load-balancer custom rule
Updates an existing load-balancer custom rule of a load-balancer.
Authorizations:
path Parameters
id required | string <uuid> |
load_balancer_id required | string |
service_id required | string |
Request Body schema: application/json
load_balancer required | string <uuid> |
matching_rule required | any |
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ |
origin_set required | string <uuid> |
priority | integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ] |
Responses
Request samples
- Payload
{- "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
- "matching_rule": null,
- "name": "string",
- "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
- "priority": -9223372036854776000
}
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "load_balancer": "8047d617-fd88-4d96-bc7a-f7af422a4684",
- "matching_rule": null,
- "name": "string",
- "origin_set": "ef7a9ba9-aa71-439d-ba74-768e986e8c01",
- "origin_set_name": "string",
- "priority": -9223372036854776000
}
Get all loggings
Returns the list of loggings of a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Responses
Response samples
- 200
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "s3_bucket": "string",
- "s3_domain": "string",
- "s3_path": "string",
- "s3_region": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "S3"
}
]
Create a new logging
Adds a new logging to a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Request Body schema: application/json
credentials | string |
name | string |
s3_bucket required | string |
s3_domain | string <= 1024 characters |
s3_path | string <= 1024 characters |
s3_region | string <= 1024 characters |
service required | string <uuid> |
type | string (UnifiedLogDestinationTypeEnum) Enum: "S3" "S3_COMPATIBLE"
|
Responses
Request samples
- Payload
{- "credentials": "string",
- "name": "string",
- "s3_bucket": "string",
- "s3_domain": "string",
- "s3_path": "string",
- "s3_region": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "S3"
}
Response samples
- 201
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "s3_bucket": "string",
- "s3_domain": "string",
- "s3_path": "string",
- "s3_region": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "S3"
}
Retrieve a logging
Gets a specific logging.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "s3_bucket": "string",
- "s3_domain": "string",
- "s3_path": "string",
- "s3_region": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "S3"
}
Update an existing logging
Updates an existing logging of a service.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Request Body schema: application/json
credentials | string |
name | string |
s3_bucket required | string |
s3_domain | string <= 1024 characters |
s3_path | string <= 1024 characters |
s3_region | string <= 1024 characters |
service required | string <uuid> |
type | string (UnifiedLogDestinationTypeEnum) Enum: "S3" "S3_COMPATIBLE"
|
Responses
Request samples
- Payload
{- "credentials": "string",
- "name": "string",
- "s3_bucket": "string",
- "s3_domain": "string",
- "s3_path": "string",
- "s3_region": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "S3"
}
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "s3_bucket": "string",
- "s3_domain": "string",
- "s3_path": "string",
- "s3_region": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "S3"
}
Get all origin-sets
Returns the list of origin-sets of a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Responses
Response samples
- 200
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "origins": [
- {
- "host": "string",
- "port": 65535,
- "protocol": "HTTP",
- "weight": 255
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
]
Create a new origin-set
Adds a new origin-set to a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Request Body schema: application/json
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ |
required | Array of objects (OriginSetMember) |
service required | string <uuid> |
Responses
Request samples
- Payload
{- "name": "string",
- "origins": [
- {
- "host": "string",
- "port": 65535,
- "protocol": "HTTP",
- "weight": 255
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Response samples
- 201
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "origins": [
- {
- "host": "string",
- "port": 65535,
- "protocol": "HTTP",
- "weight": 255
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Retrieve an origin-set
Gets a specific origin-set.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Responses
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "origins": [
- {
- "host": "string",
- "port": 65535,
- "protocol": "HTTP",
- "weight": 255
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Update an existing origin-set
Updates an existing origin-set of a service.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Request Body schema: application/json
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ |
required | Array of objects (OriginSetMember) |
service required | string <uuid> |
Responses
Request samples
- Payload
{- "name": "string",
- "origins": [
- {
- "host": "string",
- "port": 65535,
- "protocol": "HTTP",
- "weight": 255
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Response samples
- 200
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "origins": [
- {
- "host": "string",
- "port": 65535,
- "protocol": "HTTP",
- "weight": 255
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Get all origins
Returns the list of origins of a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Responses
Response samples
- 200
[- {
- "host": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_private_s3": true,
- "is_s3": true,
- "path": "string",
- "port": 65535,
- "protocol": "HTTP",
- "s3_aws_region": "string",
- "s3_bucket_name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "service_provider": {
- "account_provider": "47bf4c54-d188-4d3d-9806-5f87b0246c21",
- "akamai_amd_stream": "string",
- "cname": "string",
- "display_name": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "restored": true,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "status": "string",
- "status_details": "string",
- "use_akamai_media_services": true
}, - "shield_location": null,
- "shield_providers": [
- {
- "provider_location": "string",
- "service_provider": "ca1dd979-6d1b-4649-bab4-775da618b9c8"
}
], - "timeout_ms": -2147483648,
- "type": "CUSTOM"
}
]
Create a new origin
Adds a new origin to a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Request Body schema: application/json
host required | string <= 255 characters (^(?=.{1,253}\.)[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-... |
is_private_s3 | boolean |
is_s3 | boolean |
path | string |
port required | integer [ 0 .. 65535 ] |
protocol | string (ProtocolEnum) Enum: "HTTP" "HTTPS" "HTTP & HTTPS"
|
s3_aws_region | string or null |
s3_bucket_name | string or null |
service required | string <uuid> |
object or null | |
shield_location | any or null |
Array of objects (OriginShieldProvider) | |
timeout_ms | integer or null [ -2147483648 .. 2147483647 ] |
type | string (OriginTypeEnum) Enum: "CUSTOM" "SERVICE_PROVIDER"
|
Responses
Request samples
- Payload
{- "host": "string",
- "is_private_s3": true,
- "is_s3": true,
- "path": "string",
- "port": 65535,
- "protocol": "HTTP",
- "s3_aws_region": "string",
- "s3_bucket_name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "service_provider": {
- "account_provider": "47bf4c54-d188-4d3d-9806-5f87b0246c21",
- "akamai_amd_stream": "string",
- "cname": "string",
- "display_name": "string",
- "is_unmanaged": false,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "use_akamai_media_services": true
}, - "shield_location": null,
- "shield_providers": [
- {
- "service_provider": "ca1dd979-6d1b-4649-bab4-775da618b9c8"
}
], - "timeout_ms": -2147483648,
- "type": "CUSTOM"
}
Response samples
- 201
{- "host": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_private_s3": true,
- "is_s3": true,
- "path": "string",
- "port": 65535,
- "protocol": "HTTP",
- "s3_aws_region": "string",
- "s3_bucket_name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "service_provider": {
- "account_provider": "47bf4c54-d188-4d3d-9806-5f87b0246c21",
- "akamai_amd_stream": "string",
- "cname": "string",
- "display_name": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "restored": true,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "status": "string",
- "status_details": "string",
- "use_akamai_media_services": true
}, - "shield_location": null,
- "shield_providers": [
- {
- "provider_location": "string",
- "service_provider": "ca1dd979-6d1b-4649-bab4-775da618b9c8"
}
], - "timeout_ms": -2147483648,
- "type": "CUSTOM"
}
Retrieve an origin
Gets a specific origin.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Responses
Response samples
- 200
{- "host": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_private_s3": true,
- "is_s3": true,
- "path": "string",
- "port": 65535,
- "protocol": "HTTP",
- "s3_aws_region": "string",
- "s3_bucket_name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "service_provider": {
- "account_provider": "47bf4c54-d188-4d3d-9806-5f87b0246c21",
- "akamai_amd_stream": "string",
- "cname": "string",
- "display_name": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "restored": true,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "status": "string",
- "status_details": "string",
- "use_akamai_media_services": true
}, - "shield_location": null,
- "shield_providers": [
- {
- "provider_location": "string",
- "service_provider": "ca1dd979-6d1b-4649-bab4-775da618b9c8"
}
], - "timeout_ms": -2147483648,
- "type": "CUSTOM"
}
Update an existing origin
Updates an existing origin of a service.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Request Body schema: application/json
host required | string <= 255 characters (^(?=.{1,253}\.)[a-zA-Z0-9_-]+(\.[a-zA-Z0-9_-... |
is_private_s3 | boolean |
is_s3 | boolean |
path | string |
port required | integer [ 0 .. 65535 ] |
protocol | string (ProtocolEnum) Enum: "HTTP" "HTTPS" "HTTP & HTTPS"
|
s3_aws_region | string or null |
s3_bucket_name | string or null |
service required | string <uuid> |
object or null | |
shield_location | any or null |
Array of objects (OriginShieldProvider) | |
timeout_ms | integer or null [ -2147483648 .. 2147483647 ] |
type | string (OriginTypeEnum) Enum: "CUSTOM" "SERVICE_PROVIDER"
|
Responses
Request samples
- Payload
{- "host": "string",
- "is_private_s3": true,
- "is_s3": true,
- "path": "string",
- "port": 65535,
- "protocol": "HTTP",
- "s3_aws_region": "string",
- "s3_bucket_name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "service_provider": {
- "account_provider": "47bf4c54-d188-4d3d-9806-5f87b0246c21",
- "akamai_amd_stream": "string",
- "cname": "string",
- "display_name": "string",
- "is_unmanaged": false,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "use_akamai_media_services": true
}, - "shield_location": null,
- "shield_providers": [
- {
- "service_provider": "ca1dd979-6d1b-4649-bab4-775da618b9c8"
}
], - "timeout_ms": -2147483648,
- "type": "CUSTOM"
}
Response samples
- 200
{- "host": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_private_s3": true,
- "is_s3": true,
- "path": "string",
- "port": 65535,
- "protocol": "HTTP",
- "s3_aws_region": "string",
- "s3_bucket_name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "service_provider": {
- "account_provider": "47bf4c54-d188-4d3d-9806-5f87b0246c21",
- "akamai_amd_stream": "string",
- "cname": "string",
- "display_name": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "restored": true,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "status": "string",
- "status_details": "string",
- "use_akamai_media_services": true
}, - "shield_location": null,
- "shield_providers": [
- {
- "provider_location": "string",
- "service_provider": "ca1dd979-6d1b-4649-bab4-775da618b9c8"
}
], - "timeout_ms": -2147483648,
- "type": "CUSTOM"
}
Get all performance-checks
Returns the list of performance-checks of a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Responses
Response samples
- 200
[- {
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "url": "string"
}
]
Create a new performance-check
Adds a new performance-check to a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Request Body schema: application/json
enabled | boolean |
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ |
service required | string <uuid> |
url required | string <= 1024 characters |
Responses
Request samples
- Payload
{- "enabled": true,
- "name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "url": "string"
}
Response samples
- 201
{- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "url": "string"
}
Retrieve a performance-check
Gets a specific performance-check.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Responses
Response samples
- 200
{- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "url": "string"
}
Update an existing performance-check
Updates an existing performance-check of a service.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Request Body schema: application/json
enabled | boolean |
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ |
service required | string <uuid> |
url required | string <= 1024 characters |
Responses
Request samples
- Payload
{- "enabled": true,
- "name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "url": "string"
}
Response samples
- 200
{- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "url": "string"
}
Get all protocol configs
Returns the list of protocol configs of a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Responses
Response samples
- 200
[- {
- "http2_enabled": true,
- "http3_enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ipv6_enabled": true,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
]
Create a new protocol config
Adds a new protocol config to a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Request Body schema: application/json
http2_enabled | boolean Allow HTTP/2 |
http3_enabled | boolean Allow HTTP/3 |
ipv6_enabled | boolean Enable IPv6 |
service required | string <uuid> |
Responses
Request samples
- Payload
{- "http2_enabled": true,
- "http3_enabled": true,
- "ipv6_enabled": true,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Response samples
- 201
{- "http2_enabled": true,
- "http3_enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ipv6_enabled": true,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Retrieve a protocol config
Gets a specific protocol config.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Responses
Response samples
- 200
{- "http2_enabled": true,
- "http3_enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ipv6_enabled": true,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Update an existing protocol config
Updates an existing protocol config of a service.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Request Body schema: application/json
http2_enabled | boolean Allow HTTP/2 |
http3_enabled | boolean Allow HTTP/3 |
ipv6_enabled | boolean Enable IPv6 |
service required | string <uuid> |
Responses
Request samples
- Payload
{- "http2_enabled": true,
- "http3_enabled": true,
- "ipv6_enabled": true,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Response samples
- 200
{- "http2_enabled": true,
- "http3_enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "ipv6_enabled": true,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Get all service-providers
Returns the list of service-providers of a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Responses
Response samples
- 200
[- {
- "account_provider": "47bf4c54-d188-4d3d-9806-5f87b0246c21",
- "akamai_amd_stream": "string",
- "cname": "string",
- "display_name": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "restored": true,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "status": "string",
- "status_details": "string",
- "use_akamai_media_services": true
}
]
Create a new service-provider
Adds a new service-provider to a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Request Body schema: application/json
account_provider | string <uuid> |
akamai_amd_stream | string or null |
cname | string or null <= 255 characters |
display_name | string or null <= 255 characters |
is_unmanaged | boolean Default: false |
service required | string <uuid> |
use_akamai_media_services | boolean |
Responses
Request samples
- Payload
{- "account_provider": "47bf4c54-d188-4d3d-9806-5f87b0246c21",
- "akamai_amd_stream": "string",
- "cname": "string",
- "display_name": "string",
- "is_unmanaged": false,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "use_akamai_media_services": true
}
Response samples
- 201
{- "account_provider": "47bf4c54-d188-4d3d-9806-5f87b0246c21",
- "akamai_amd_stream": "string",
- "cname": "string",
- "display_name": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "restored": true,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "status": "string",
- "status_details": "string",
- "use_akamai_media_services": true
}
Retrieve a service-provider
Gets a specific service-provider.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Responses
Response samples
- 200
{- "account_provider": "47bf4c54-d188-4d3d-9806-5f87b0246c21",
- "akamai_amd_stream": "string",
- "cname": "string",
- "display_name": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "restored": true,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "status": "string",
- "status_details": "string",
- "use_akamai_media_services": true
}
Update an existing service-provider
Updates an existing service-provider of a service.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Request Body schema: application/json
account_provider | string <uuid> |
akamai_amd_stream | string or null |
cname | string or null <= 255 characters |
display_name | string or null <= 255 characters |
is_unmanaged | boolean Default: false |
service required | string <uuid> |
use_akamai_media_services | boolean |
Responses
Request samples
- Payload
{- "account_provider": "47bf4c54-d188-4d3d-9806-5f87b0246c21",
- "akamai_amd_stream": "string",
- "cname": "string",
- "display_name": "string",
- "is_unmanaged": false,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "use_akamai_media_services": true
}
Response samples
- 200
{- "account_provider": "47bf4c54-d188-4d3d-9806-5f87b0246c21",
- "akamai_amd_stream": "string",
- "cname": "string",
- "display_name": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "restored": true,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "status": "string",
- "status_details": "string",
- "use_akamai_media_services": true
}
Get all request-loggings
Returns the list of request-loggings of a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Responses
Response samples
- 200
[- {
- "bucket_name": "string",
- "domain": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "path": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "AWS_S3"
}
]
Create a new request-logging
Adds a new request-logging to a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Request Body schema: application/json
bucket_name required | string <= 1024 characters |
credentials required | string <= 4096 characters |
domain | string <= 1024 characters |
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ |
path | string <= 1024 characters |
service required | string <uuid> |
type required | string (Type565Enum) Value: "AWS_S3"
|
Responses
Request samples
- Payload
{- "bucket_name": "string",
- "credentials": "string",
- "domain": "string",
- "name": "string",
- "path": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "AWS_S3"
}
Response samples
- 201
{- "bucket_name": "string",
- "domain": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "path": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "AWS_S3"
}
Retrieve a request-logging
Gets a specific request-logging.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Responses
Response samples
- 200
{- "bucket_name": "string",
- "domain": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "path": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "AWS_S3"
}
Update an existing request-logging
Updates an existing request-logging of a service.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Request Body schema: application/json
bucket_name required | string <= 1024 characters |
credentials required | string <= 4096 characters |
domain | string <= 1024 characters |
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ |
path | string <= 1024 characters |
service required | string <uuid> |
type required | string (Type565Enum) Value: "AWS_S3"
|
Responses
Request samples
- Payload
{- "bucket_name": "string",
- "credentials": "string",
- "domain": "string",
- "name": "string",
- "path": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "AWS_S3"
}
Response samples
- 200
{- "bucket_name": "string",
- "domain": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "path": "string",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "AWS_S3"
}
Get all request-logging rules
Returns the list of request-logging rules of a request-logging.
Authorizations:
path Parameters
service_id required | string |
Responses
Response samples
- 200
[- {
- "destination": "5332a938-399a-405c-8866-445d97d52324",
- "destination_name": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "log_body": true,
- "methods": "string",
- "name": "string",
- "path_pattern": "string",
- "sampling_rate": 100,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "stage": "origin-request"
}
]
Create a new request-logging rule
Adds a new request-logging rule to a request-logging.
Authorizations:
path Parameters
service_id required | string |
Request Body schema: application/json
destination required | string <uuid> |
log_body | boolean |
methods required | string <= 100 characters |
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ |
path_pattern required | string <= 1024 characters |
sampling_rate required | integer [ 0 .. 100 ] |
service required | string <uuid> |
stage | string (StageEnum) Value: "origin-request"
|
Responses
Request samples
- Payload
{- "destination": "5332a938-399a-405c-8866-445d97d52324",
- "log_body": true,
- "methods": "string",
- "name": "string",
- "path_pattern": "string",
- "sampling_rate": 100,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "stage": "origin-request"
}
Response samples
- 201
{- "destination": "5332a938-399a-405c-8866-445d97d52324",
- "destination_name": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "log_body": true,
- "methods": "string",
- "name": "string",
- "path_pattern": "string",
- "sampling_rate": 100,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "stage": "origin-request"
}
Retrieve a request-logging rule
Gets a specific request-logging rule.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string |
Responses
Response samples
- 200
{- "destination": "5332a938-399a-405c-8866-445d97d52324",
- "destination_name": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "log_body": true,
- "methods": "string",
- "name": "string",
- "path_pattern": "string",
- "sampling_rate": 100,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "stage": "origin-request"
}
Update an existing request-logging rule
Updates an existing request-logging rule of a request-logging.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string |
Request Body schema: application/json
destination required | string <uuid> |
log_body | boolean |
methods required | string <= 100 characters |
name required | string <= 255 characters ^[a-zA-Z0-9_\-\s]*$ |
path_pattern required | string <= 1024 characters |
sampling_rate required | integer [ 0 .. 100 ] |
service required | string <uuid> |
stage | string (StageEnum) Value: "origin-request"
|
Responses
Request samples
- Payload
{- "destination": "5332a938-399a-405c-8866-445d97d52324",
- "log_body": true,
- "methods": "string",
- "name": "string",
- "path_pattern": "string",
- "sampling_rate": 100,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "stage": "origin-request"
}
Response samples
- 200
{- "destination": "5332a938-399a-405c-8866-445d97d52324",
- "destination_name": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "log_body": true,
- "methods": "string",
- "name": "string",
- "path_pattern": "string",
- "sampling_rate": 100,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "stage": "origin-request"
}
Get all traffic policies
Returns the list of traffic policies of a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Responses
Response samples
- 200
[- {
- "enable_performance_penalty": true,
- "failover": true,
- "geos": [
- {
- "continent": "string",
- "country": "string",
- "subdivision": "string"
}
], - "health_checks": [
- {
- "health_check": "26702727-a685-4d94-84ea-76389f752de3"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_default": true,
- "performance_checks": [
- {
- "performance_check": "1886fe69-3884-4578-9182-eb8e5cb94795"
}
], - "performance_penalty": 10,
- "providers": [
- {
- "is_commitment_priority": true,
- "priority": -2147483648,
- "service_provider": "ca1dd979-6d1b-4649-bab4-775da618b9c8",
- "weight": -2147483648
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "Static"
}
]
Create a new traffic policy
Adds a new traffic policy to a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Request Body schema: application/json
enable_performance_penalty | boolean or null |
failover | boolean |
required | Array of objects (TrafficPolicyGeo) |
required | Array of objects (TrafficPolicyHealthCheck) |
is_default | boolean |
required | Array of objects (TrafficPolicyPerformanceCheck) |
performance_penalty | integer or null [ 10 .. 300 ] |
required | Array of objects (TrafficPolicyProvider) |
service required | string <uuid> |
type required | string (TrafficPolicyTypeEnum) Enum: "Static" "Dynamic" "Cost based"
|
Responses
Request samples
- Payload
{- "enable_performance_penalty": true,
- "failover": true,
- "geos": [
- {
- "continent": "string",
- "country": "string",
- "subdivision": "string"
}
], - "health_checks": [
- {
- "health_check": "26702727-a685-4d94-84ea-76389f752de3"
}
], - "is_default": true,
- "performance_checks": [
- {
- "performance_check": "1886fe69-3884-4578-9182-eb8e5cb94795"
}
], - "performance_penalty": 10,
- "providers": [
- {
- "is_commitment_priority": true,
- "priority": -2147483648,
- "service_provider": "ca1dd979-6d1b-4649-bab4-775da618b9c8",
- "weight": -2147483648
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "Static"
}
Response samples
- 201
{- "enable_performance_penalty": true,
- "failover": true,
- "geos": [
- {
- "continent": "string",
- "country": "string",
- "subdivision": "string"
}
], - "health_checks": [
- {
- "health_check": "26702727-a685-4d94-84ea-76389f752de3"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_default": true,
- "performance_checks": [
- {
- "performance_check": "1886fe69-3884-4578-9182-eb8e5cb94795"
}
], - "performance_penalty": 10,
- "providers": [
- {
- "is_commitment_priority": true,
- "priority": -2147483648,
- "service_provider": "ca1dd979-6d1b-4649-bab4-775da618b9c8",
- "weight": -2147483648
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "Static"
}
Retrieve a traffic policy
Gets a specific traffic policy.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Responses
Response samples
- 200
{- "enable_performance_penalty": true,
- "failover": true,
- "geos": [
- {
- "continent": "string",
- "country": "string",
- "subdivision": "string"
}
], - "health_checks": [
- {
- "health_check": "26702727-a685-4d94-84ea-76389f752de3"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_default": true,
- "performance_checks": [
- {
- "performance_check": "1886fe69-3884-4578-9182-eb8e5cb94795"
}
], - "performance_penalty": 10,
- "providers": [
- {
- "is_commitment_priority": true,
- "priority": -2147483648,
- "service_provider": "ca1dd979-6d1b-4649-bab4-775da618b9c8",
- "weight": -2147483648
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "Static"
}
Update an existing traffic policy
Updates an existing traffic policy of a service.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Request Body schema: application/json
enable_performance_penalty | boolean or null |
failover | boolean |
required | Array of objects (TrafficPolicyGeo) |
required | Array of objects (TrafficPolicyHealthCheck) |
is_default | boolean |
required | Array of objects (TrafficPolicyPerformanceCheck) |
performance_penalty | integer or null [ 10 .. 300 ] |
required | Array of objects (TrafficPolicyProvider) |
service required | string <uuid> |
type required | string (TrafficPolicyTypeEnum) Enum: "Static" "Dynamic" "Cost based"
|
Responses
Request samples
- Payload
{- "enable_performance_penalty": true,
- "failover": true,
- "geos": [
- {
- "continent": "string",
- "country": "string",
- "subdivision": "string"
}
], - "health_checks": [
- {
- "health_check": "26702727-a685-4d94-84ea-76389f752de3"
}
], - "is_default": true,
- "performance_checks": [
- {
- "performance_check": "1886fe69-3884-4578-9182-eb8e5cb94795"
}
], - "performance_penalty": 10,
- "providers": [
- {
- "is_commitment_priority": true,
- "priority": -2147483648,
- "service_provider": "ca1dd979-6d1b-4649-bab4-775da618b9c8",
- "weight": -2147483648
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "Static"
}
Response samples
- 200
{- "enable_performance_penalty": true,
- "failover": true,
- "geos": [
- {
- "continent": "string",
- "country": "string",
- "subdivision": "string"
}
], - "health_checks": [
- {
- "health_check": "26702727-a685-4d94-84ea-76389f752de3"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "is_default": true,
- "performance_checks": [
- {
- "performance_check": "1886fe69-3884-4578-9182-eb8e5cb94795"
}
], - "performance_penalty": 10,
- "providers": [
- {
- "is_commitment_priority": true,
- "priority": -2147483648,
- "service_provider": "ca1dd979-6d1b-4649-bab4-775da618b9c8",
- "weight": -2147483648
}
], - "service": "cd8c5e52-093e-43db-9c42-184f00e681dd",
- "type": "Static"
}
Get all waf custom rules
Returns the list of waf custom rules of a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Responses
Response samples
- 200
[- {
- "action": "string",
- "condition_groups": [
- {
- "conditions": [
- {
- "field": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "operator": "string",
- "value": "string"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
], - "duration_seconds": -2147483648,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "internal_id": -2147483648,
- "name": "string",
- "num_of_requests": -2147483648,
- "priority": -9223372036854776000,
- "service_uid": "string",
- "time_window_seconds": -2147483648,
- "type": "string",
- "waf": "be821be9-8275-4bac-ad93-c8b47b26afea"
}
]
Create a new waf custom rule
Adds a new waf custom rule to a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Request Body schema: application/json
action | string <= 50 characters |
required | Array of objects (WAFCustomRuleConditionGroup) |
duration_seconds | integer or null [ -2147483648 .. 2147483647 ] |
enabled | boolean |
internal_id | integer or null [ -2147483648 .. 2147483647 ] |
name required | string <= 255 characters |
num_of_requests | integer or null [ -2147483648 .. 2147483647 ] |
priority | integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ] |
time_window_seconds | integer or null [ -2147483648 .. 2147483647 ] |
type | string |
waf required | string <uuid> |
Responses
Request samples
- Payload
{- "action": "string",
- "condition_groups": [
- {
- "conditions": [
- {
- "field": "string",
- "operator": "string",
- "value": "string"
}
]
}
], - "duration_seconds": -2147483648,
- "enabled": true,
- "internal_id": -2147483648,
- "name": "string",
- "num_of_requests": -2147483648,
- "priority": -9223372036854776000,
- "time_window_seconds": -2147483648,
- "type": "string",
- "waf": "be821be9-8275-4bac-ad93-c8b47b26afea"
}
Response samples
- 201
{- "action": "string",
- "condition_groups": [
- {
- "conditions": [
- {
- "field": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "operator": "string",
- "value": "string"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
], - "duration_seconds": -2147483648,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "internal_id": -2147483648,
- "name": "string",
- "num_of_requests": -2147483648,
- "priority": -9223372036854776000,
- "service_uid": "string",
- "time_window_seconds": -2147483648,
- "type": "string",
- "waf": "be821be9-8275-4bac-ad93-c8b47b26afea"
}
Retrieve a waf custom rule
Gets a specific waf custom rule.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Responses
Response samples
- 200
{- "action": "string",
- "condition_groups": [
- {
- "conditions": [
- {
- "field": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "operator": "string",
- "value": "string"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
], - "duration_seconds": -2147483648,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "internal_id": -2147483648,
- "name": "string",
- "num_of_requests": -2147483648,
- "priority": -9223372036854776000,
- "service_uid": "string",
- "time_window_seconds": -2147483648,
- "type": "string",
- "waf": "be821be9-8275-4bac-ad93-c8b47b26afea"
}
Update an existing waf custom rule
Updates an existing waf custom rule of a service.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Request Body schema: application/json
action | string <= 50 characters |
required | Array of objects (WAFCustomRuleConditionGroup) |
duration_seconds | integer or null [ -2147483648 .. 2147483647 ] |
enabled | boolean |
internal_id | integer or null [ -2147483648 .. 2147483647 ] |
name required | string <= 255 characters |
num_of_requests | integer or null [ -2147483648 .. 2147483647 ] |
priority | integer or null <int64> [ -9223372036854776000 .. 9223372036854776000 ] |
time_window_seconds | integer or null [ -2147483648 .. 2147483647 ] |
type | string |
waf required | string <uuid> |
Responses
Request samples
- Payload
{- "action": "string",
- "condition_groups": [
- {
- "conditions": [
- {
- "field": "string",
- "operator": "string",
- "value": "string"
}
]
}
], - "duration_seconds": -2147483648,
- "enabled": true,
- "internal_id": -2147483648,
- "name": "string",
- "num_of_requests": -2147483648,
- "priority": -9223372036854776000,
- "time_window_seconds": -2147483648,
- "type": "string",
- "waf": "be821be9-8275-4bac-ad93-c8b47b26afea"
}
Response samples
- 200
{- "action": "string",
- "condition_groups": [
- {
- "conditions": [
- {
- "field": "string",
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "operator": "string",
- "value": "string"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}
], - "duration_seconds": -2147483648,
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "internal_id": -2147483648,
- "name": "string",
- "num_of_requests": -2147483648,
- "priority": -9223372036854776000,
- "service_uid": "string",
- "time_window_seconds": -2147483648,
- "type": "string",
- "waf": "be821be9-8275-4bac-ad93-c8b47b26afea"
}
Get all waf loggings
Returns the list of waf loggings of a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Responses
Response samples
- 200
[- {
- "bucket_name": "string",
- "domain": "string",
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "path": "string",
- "type": "AWS_S3",
- "waf": "be821be9-8275-4bac-ad93-c8b47b26afea"
}
]
Create a new waf logging
Adds a new waf logging to a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Request Body schema: application/json
bucket_name required | string <= 1024 characters |
credentials required | string <= 4096 characters |
domain | string <= 1024 characters |
enabled | boolean |
path | string <= 1024 characters |
type required | string (Type565Enum) Value: "AWS_S3"
|
waf required | string <uuid> |
Responses
Request samples
- Payload
{- "bucket_name": "string",
- "credentials": "string",
- "domain": "string",
- "enabled": true,
- "path": "string",
- "type": "AWS_S3",
- "waf": "be821be9-8275-4bac-ad93-c8b47b26afea"
}
Response samples
- 201
{- "bucket_name": "string",
- "domain": "string",
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "path": "string",
- "type": "AWS_S3",
- "waf": "be821be9-8275-4bac-ad93-c8b47b26afea"
}
Retrieve a waf logging
Gets a specific waf logging.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Responses
Response samples
- 200
{- "bucket_name": "string",
- "domain": "string",
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "path": "string",
- "type": "AWS_S3",
- "waf": "be821be9-8275-4bac-ad93-c8b47b26afea"
}
Update an existing waf logging
Updates an existing waf logging of a service.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Request Body schema: application/json
bucket_name required | string <= 1024 characters |
credentials required | string <= 4096 characters |
domain | string <= 1024 characters |
enabled | boolean |
path | string <= 1024 characters |
type required | string (Type565Enum) Value: "AWS_S3"
|
waf required | string <uuid> |
Responses
Request samples
- Payload
{- "bucket_name": "string",
- "credentials": "string",
- "domain": "string",
- "enabled": true,
- "path": "string",
- "type": "AWS_S3",
- "waf": "be821be9-8275-4bac-ad93-c8b47b26afea"
}
Response samples
- 200
{- "bucket_name": "string",
- "domain": "string",
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "path": "string",
- "type": "AWS_S3",
- "waf": "be821be9-8275-4bac-ad93-c8b47b26afea"
}
Get all WAF managed rule sets
Returns the list of WAF managed rule sets of a service.
Authorizations:
path Parameters
service_id required | string <uuid> |
Responses
Response samples
- 200
[- {
- "anomaly_threshold": 1,
- "block": true,
- "display_name": "string",
- "enabled": true,
- "groups": [
- {
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "rule_prefix": "string"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "overrides": [
- {
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "rule_id": -2147483648
}
], - "paranoia_level": 1,
- "waf": "be821be9-8275-4bac-ad93-c8b47b26afea"
}
]
Retrieve a WAF managed rule set
Gets a specific WAF managed rule set.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Responses
Response samples
- 200
{- "anomaly_threshold": 1,
- "block": true,
- "display_name": "string",
- "enabled": true,
- "groups": [
- {
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "rule_prefix": "string"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "overrides": [
- {
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "rule_id": -2147483648
}
], - "paranoia_level": 1,
- "waf": "be821be9-8275-4bac-ad93-c8b47b26afea"
}
Update an existing WAF managed rule set
Updates an existing WAF managed rule set of a service.
Authorizations:
path Parameters
id required | string <uuid> |
service_id required | string <uuid> |
Request Body schema: application/json
anomaly_threshold | integer [ 1 .. 2147483647 ] |
block | boolean |
display_name required | string <= 255 characters |
enabled | boolean |
required | Array of objects (WAFManagedRuleGroup) |
name required | string <= 50 characters |
required | Array of objects (WAFOverrideManagedRule) |
paranoia_level | integer [ 1 .. 4 ] |
waf required | string <uuid> |
Responses
Request samples
- Payload
{- "anomaly_threshold": 1,
- "block": true,
- "display_name": "string",
- "enabled": true,
- "groups": [
- {
- "enabled": true,
- "rule_prefix": "string"
}
], - "name": "string",
- "overrides": [
- {
- "enabled": true,
- "rule_id": -2147483648
}
], - "paranoia_level": 1,
- "waf": "be821be9-8275-4bac-ad93-c8b47b26afea"
}
Response samples
- 200
{- "anomaly_threshold": 1,
- "block": true,
- "display_name": "string",
- "enabled": true,
- "groups": [
- {
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "rule_prefix": "string"
}
], - "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "name": "string",
- "overrides": [
- {
- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "rule_id": -2147483648
}
], - "paranoia_level": 1,
- "waf": "be821be9-8275-4bac-ad93-c8b47b26afea"
}
Retrieve WAF settings
Get WAF settings of a service.
Authorizations:
path Parameters
service required | string |
Responses
Response samples
- 200
{- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Update WAF settings
Authorizations:
path Parameters
service required | string |
Request Body schema: application/json
enabled | boolean |
service required | string <uuid> |
Responses
Request samples
- Payload
{- "enabled": true,
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Response samples
- 200
{- "enabled": true,
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "service": "cd8c5e52-093e-43db-9c42-184f00e681dd"
}
Get Traffic Overtime
Get Traffic Overtime
Authorizations:
path Parameters
service_ids required | string Comma separated list of service IDs |
query Parameters
startTime required | integer |
endTime required | integer |
granularity | string Enum: "MINUTE" "HOUR" "DAY" |
Responses
Response samples
- 200
{- "granularity": "MINUTE",
- "serviceStats": [
- {
- "points": [
- {
- "metrics": [
- {
- "metrics": {
- "bytes": 0,
- "cachedBytesPercentage": 0,
- "cachedHitsPercentage": 0,
- "errorsPercentage": 0,
- "hits": 0
}, - "providerName": "string"
}
], - "timestamp": 0
}
], - "serviceID": "string"
}
]
}