v32

latestOpenAPI 3.1.0raw.githubusercontent.com2026-05-151,1412,2144.5 MB

CDN resources

Get CDN resource details

get/cdn/resources/{resource_id}

Path parameters

resource_idinteger required

CDN resource ID.

Response

Successful.

idinteger

CDN resource ID.

cnamestring

Delivery domains that will be used for content delivery through a CDN.

Delivery domains should be added to your DNS settings.

activeboolean

Enables or disables a CDN resource.

Possible values:

true - CDN resource is active. Content is being delivered.
false - CDN resource is deactivated. Content is not being delivered.

enabledboolean

Enables or disables a CDN resource change by a user.

Possible values:

true - CDN resource is enabled and can be changed. Content can be delivered.
false - CDN resource is disabled and cannot be changed. Content can not be delivered.

status'active' | 'suspended' | 'processed' | 'deleted'

CDN resource status.

Possible values:

active - CDN resource is active. Content is available to users.
suspended - CDN resource is suspended. Content is not available to users.
processed - CDN resource has recently been created and is currently being processed. It will take about fifteen minutes to propagate it to all locations.
deleted - CDN resource is deleted.

deletedboolean

Defines whether CDN resource has been deleted.

Possible values:

true - CDN resource is deleted.
false - CDN resource is not deleted.

clientinteger

ID of an account to which the CDN resource belongs.

namestring nullable

CDN resource name.

descriptionstring

Optional comment describing the CDN resource.

createdstring

Date of CDN resource creation.

updatedstring

Date of the last CDN resource update.

originGroupinteger

Origin group ID with which the CDN resource is associated.

originGroup_namestring

Origin group name.

originProtocol'HTTP' | 'HTTPS' | 'MATCH'

Protocol used by CDN servers to request content from an origin source.

Possible values:

HTTPS - CDN servers will connect to the origin via HTTPS.
HTTP - CDN servers will connect to the origin via HTTP.
MATCH - connection protocol will be chosen automatically (content on the origin source should be available for the CDN both through HTTP and HTTPS).

If protocol is not specified, HTTP is used to connect to an origin server.

secondaryHostnamesstring[]

Additional delivery domains (CNAMEs) that will be used to deliver content via the CDN.

Up to ten additional CNAMEs are possible.

shieldedboolean

Defines whether origin shielding feature is enabled for the resource.

Possible values:

true - Origin shielding is enabled.
false - Origin shielding is disabled.

shield_dcstring nullable

Name of the origin shielding location data center.

Parameter returns null if origin shielding is disabled.

shield_enabledboolean

Defines whether origin shield is active and working for the CDN resource.

Possible values:

true - Origin shield is active.
false - Origin shield is not active.

shield_routing_mapinteger nullable

Defines whether the origin shield with a dynamic location is enabled for the CDN resource.

To manage origin shielding, you must contact customer support.

sslEnabledboolean

Defines whether the HTTPS protocol enabled for content delivery.

Possible values:

true - HTTPS is enabled.
false - HTTPS is disabled.

sslDatainteger nullable

ID of the SSL certificate linked to the CDN resource.

Can be used only with "sslEnabled": true.

proxy_ssl_enabledboolean

Enables or disables SSL certificate validation of the origin server before completing any connection.

Possible values:

true - Origin SSL certificate validation is enabled.
false - Origin SSL certificate validation is disabled.

proxy_ssl_cainteger nullable

ID of the trusted CA certificate used to verify an origin.

It can be used only with "proxy_ssl_enabled": true.

proxy_ssl_datainteger nullable

ID of the SSL certificate used to verify an origin.

It can be used only with "proxy_ssl_enabled": true.

preset_appliedboolean

Defines whether the CDN resource has a preset applied.

Possible values:

true - CDN resource has a preset applied. CDN resource options included in the preset cannot be edited.
false - CDN resource does not have a preset applied.

vp_enabledboolean

Defines whether the CDN resource is integrated with the Streaming Platform.

Possible values:

true - CDN resource is configured for Streaming Platform. Changing resource settings can affect its operation.
false - CDN resource is not configured for Streaming Platform.

full_custom_enabledboolean

Defines whether the CDN resource has a custom configuration.

Possible values:

true - CDN resource has a custom configuration. You cannot change resource settings, except for the SSL certificate. To change other settings, contact technical support.
false - CDN resource has a regular configuration. You can change CDN resource settings.

can_purge_by_urlsboolean

Defines whether the CDN resource can be used for purge by URLs feature.

It's available only in case the CDN resource has enabled ignore_vary_header option.

suspend_datestring nullable

Date when the CDN resource was suspended automatically if there is no traffic on it for 90 days.

Not specified if the resource was not stopped due to lack of traffic.

suspendedboolean

Defines whether the CDN resource has been automatically suspended because there was no traffic on it for 90 days.

Possible values:

true - CDN resource is currently automatically suspended.
false - CDN resource is not automatically suspended.

You can enable CDN resource using the active field. If there is no traffic on the CDN resource within seven days following activation, it will be suspended again.

To avoid CDN resource suspension due to no traffic, contact technical support.

primary_resourceinteger nullable

ID of the main CDN resource which has a shared caching zone with a reserve CDN resource.

If the parameter is not empty, then the current CDN resource is the reserve. You cannot change some options, create rules, set up origin shielding, or use the reserve CDN resource for Streaming.

is_primaryboolean nullable

Defines whether a CDN resource has a cache zone shared with other CDN resources.

Possible values:

true - CDN resource is main and has a shared caching zone with other CDN resources, which are called reserve.
false - CDN resource is reserve and it has a shared caching zone with the main CDN resource. You cannot change some options, create rules, set up origin shielding and use the reserve resource for Streaming.
null - CDN resource does not have a shared cache zone.

The main CDN resource is specified in the primary_resource field. It cannot be suspended unless all related reserve CDN resources are suspended.

waap_domain_idstring nullable

The ID of the associated WAAP domain.

rulesobject[]

Rules configured for the CDN resource.

Example response

{
  "id": 220,
  "cname": "cdn.site.com",
  "active": true,
  "enabled": true,
  "status": "active",
  "client": 170,
  "name": "Resource for images",
  "description": "My resource",
  "created": "2017-06-10T10:30:04.954354Z",
  "updated": "2017-06-14T05:05:42.065221Z",
  "originGroup": 132,
  "originGroup_name": "Resource origin group",
  "originProtocol": "HTTPS",
  "secondaryHostnames": [
    "first.example.com",
    "second.example.com"
  ],
  "sslData": 192,
  "waap_domain_id": "123",
  "rules": [],
  "options": {
    "allowedHttpMethods": {
      "enabled": true,
      "value": [
        "GET",
        "POST"
      ]
    },
    "brotli_compression": {
      "enabled": true,
      "value": [
        "text/html",
        "text/plain"
      ]
    },
    "browser_cache_settings": {
      "enabled": true,
      "value": "3600s"
    },
    "cache_http_headers": {
      "enabled": false,
      "value": [
        "vary",
        "content-length",
        "last-modified",
        "connection",
        "accept-ranges",
        "content-type",
        "content-encoding",
        "etag",
        "cache-control",
        "expires",
        "keep-alive",
        "server"
      ]
    },
    "cors": {
      "enabled": true,
      "value": [
        "domain.com",
        "domain2.com"
      ],
      "always": true
    },
    "country_acl": {
      "enabled": true,
      "policy_type": "allow",
      "excepted_values": [
        "GB",
        "DE"
      ]
    },
    "disable_cache": {
      "enabled": true,
      "value": false
    },
    "disable_proxy_force_ranges": {
      "enabled": true,
      "value": true
    },
    "edge_cache_settings": {
      "enabled": true,
      "value": "43200s",
      "custom_values": {
        "100": "43200s"
      }
    },
    "fastedge": {
      "enabled": true,
      "on_request_headers": {
        "enabled": true,
        "app_id": "1001",
        "interrupt_on_error": true
      }
    },
    "fetch_compressed": {
      "enabled": true,
      "value": false
    },
    "follow_origin_redirect": {
      "enabled": true,
      "codes": [
        302,
        308
      ]
    },
    "force_return": {
      "enabled": true,
      "code": 301,
      "body": "http://example.com/redirect_address",
      "time_interval": {
        "start_time": "09:00",
        "end_time": "20:00",
        "time_zone": "CET"
      }
    },
    "forward_host_header": {
      "enabled": false,
      "value": false
    },
    "grpc_passthrough": {
      "enabled": true,
      "value": true
    },
    "gzipOn": {
      "enabled": true,
      "value": true
    },
    "hostHeader": {
      "enabled": true,
      "value": "host.com"
    },
    "http3_enabled": {
      "enabled": true,
      "value": true
    },
    "ignore_cookie": {
      "enabled": true,
      "value": true
    },
    "ignoreQueryString": {
      "enabled": true,
      "value": false
    },
    "image_stack": {
      "enabled": true,
      "avif_enabled": true,
      "webp_enabled": false,
      "quality": 80,
      "png_lossless": true
    },
    "ip_address_acl": {
      "enabled": true,
      "policy_type": "deny",
      "excepted_values": [
        "192.168.1.100/32"
      ]
    },
    "limit_bandwidth": {
      "enabled": true,
      "limit_type": "static",
      "speed": 100,
      "buffer": 200
    },
    "proxy_cache_key": {
      "enabled": true,
      "value": "$scheme$uri"
    },
    "proxy_cache_methods_set": {
      "enabled": true,
      "value": false
    },
    "proxy_connect_timeout": {
      "enabled": true,
      "value": "4s"
    },
    "proxy_read_timeout": {
      "enabled": true,
      "value": "10s"
    },
    "query_params_blacklist": {
      "enabled": true,
      "value": [
        "some",
        "blacklisted",
        "query"
      ]
    },
    "query_params_whitelist": {
      "enabled": true,
      "value": [
        "some",
        "whitelisted",
        "query"
      ]
    },
    "query_string_forwarding": {
      "enabled": true,
      "forward_from_file_types": [
        "m3u8",
        "mpd"
      ],
      "forward_to_file_types": [
        "ts",
        "mp4"
      ],
      "forward_only_keys": [
        "auth_token",
        "session_id"
      ],
      "forward_except_keys": [
        "debug_info"
      ]
    },
    "redirect_http_to_https": {
      "enabled": true,
      "value": true
    },
    "redirect_https_to_http": {
      "enabled": false,
      "value": true
    },
    "referrer_acl": {
      "enabled": true,
      "policy_type": "deny",
      "excepted_values": [
        "example.com",
        "*.example.net"
      ]
    },
    "response_headers_hiding_policy": {
      "enabled": true,
      "mode": "hide",
      "excepted": [
        "my-header"
      ]
    },
    "rewrite": {
      "enabled": true,
      "body": "/(.*) /additional_path/$1",
      "flag": "break"
    },
    "secure_key": {
      "enabled": true,
      "key": "secretkey",
      "type": 2
    },
    "slice": {
      "enabled": true,
      "value": true
    },
    "sni": {
      "enabled": true,
      "sni_type": "custom",
      "custom_hostname": "custom.example.com"
    },
    "stale": {
      "enabled": true,
      "value": [
        "http_404",
        "http_500"
      ]
    },
    "static_response_headers": {
      "enabled": true,
      "value": [
        {
          "name": "X-Example",
          "value": [
            "Value_1"
          ],
          "always": true
        },
        {
          "name": "X-Example-Multiple",
          "value": [
            "Value_1",
            "Value_2",
            "Value_3"
          ],
          "always": false
        }
      ]
    },
    "staticHeaders": {
      "enabled": true,
      "value": {
        "X-Example": "Value_1",
        "X-Example-Multiple": [
          "Value_2",
          "Value_3"
        ]
      }
    },
    "staticRequestHeaders": {
      "enabled": true,
      "value": {
        "Header-One": "Value 1",
        "Header-Two": "Value 2"
      }
    },
    "tls_versions": {
      "enabled": true,
      "value": [
        "SSLv3",
        "TLSv1.3"
      ]
    },
    "use_default_le_chain": {
      "enabled": true,
      "value": true
    },
    "use_dns01_le_challenge": {
      "enabled": true,
      "value": true
    },
    "use_rsa_le_cert": {
      "enabled": true,
      "value": true
    },
    "user_agent_acl": {
      "enabled": true,
      "policy_type": "allow",
      "excepted_values": [
        "UserAgent Value",
        "~*.*bot.*",
        ""
      ]
    },
    "waap": {
      "enabled": true,
      "value": true
    },
    "websockets": {
      "enabled": true,
      "value": true
    }
  }
}