API for HTTP-resource

Description

This section describes API methods for creating, deleting and configurations changing of your resources. You will as well find here information on cache managing and statistical data receiving.

All the responses (including errors) return in JSON Format.

Attention!

1. You can make no more than:
   • 20 API requests per minute for HTTP resource configuring (POST, PUT);
   • 125 API requests per minute for cache management.
2. There is a limit of 100 resources. If you need more resources, please contact your personal manager or support.

Find below examples for monitoring and configuring of the options in connection with HTTP-caching service.

General configuration

Find below an example of general configuration, while in the following sections the particular examples will be clarified.

💲 icon indicates paid services. The cost can be clarified with the manager.

        http resource json object (HRJO) - data from request/response
        HRJO structure and keys:
        { 
            id <string> - uid of resource (used in api url)
            name <string> - identificator for web UI (required)
            origin <json> - section for traffic origin description (required)
            certificate <integer> - id of created certificate
            names <json> - section for names description
            robots <json> - section for robots file description
            headers <json> - section for specific headers description
            cache <json> - section for cache options description
            client_cache <json> - section for extra cache options description
            auth <json> - 💲 section for auth options description
            cors <json> - section for cors description
            modern_tls_only <boolean> - use only modern versions of TLS
            strong_ssl_ciphers <boolean> - use strong SSL ciphers (required modern_tls_only)
            limitations <json> - 💲 section for geo, ip, referer or useragent limitations
            locations <json> - section for locations description
            compress <json> - 💲 section for compress options description
            ioss <boolean> - 💲 section for ioss options description
            packaging <json> - section for packaging options description
            tuning <string> - distribution optimization type (one of "default", "large" (for large files > 20 Mbytes), "live" (for HTTP LIVE streams))
            slice_size_megabytes <integer> - size of slice in MB (only for tuning="large")
        }  

origin section

        {
            https <boolean> - use or not https during requests to origin
            ssl_verify <boolean> - check or not certificate during requests to origin (required https)
            aws <json> - use aws authorization during requests to origin
            s3_bucket <string> - permitted bucket, set when specifying S3-domain 
            hostname <string> - set host header during requests to origin
            servers <json> - client nodes description
            read_timeout <string> - time in seconds, e.g. "10s"
            send_timeout <string> - time in seconds, e.g. "10s"
            connect_timeout <string> - time in seconds, e.g. "10s"
        }

aws section

        {
            auth <json> - authorization keys
        }

aws auth section

        {
            access_key <string> - access key
            secret_key <string> - secret key
        }

servers section

        {
            <client_domain/ip_address>: client node address <json>
        }

client node address section

        {
            port <integer> - client node port (default 80 and 443)
            weight <integer> - load balancing parameters
            max_fails <integer> - load balancing parameters
            backup <boolean> - use node only in backup mode
        }

names section

        list of string cnames, f.e. ["alias1.client.cdn.ru"]

robots section

        {
            type <string> - "deny", "custom" or "cached"
            robotsContent <string> - client’s robots.txt text (only for "custom" type)
        }

headers section

        {
            request <json> - headers for requests to origin
            response <json> - header for customer responses
        }

request headers section

        {
            <header_name>: <header_value>
        }

response headers section

        {
            <header_name>: <header_value>
        }

cache section

        {
            disable <boolean> - do not cache content
            consider_args <boolean> - use querystring while cache process
            valid <json> - time of caching
        }

valid section

        {
            2xx <string> - cache ttl for 2xx response codes
            3xx <string> - cache ttl for 3xx response codes
            4xx <string> - cache ttl for 4xx response codes
            5xx <string> - cache ttl for 5xx response codes
            force <boolean> - force cache update on clientside
        }

client cache section

        {
            expires <integer> - expire cache time
        }

cors section

        {
            disable <boolean> - disable cors (default: false)
            domains <list of strings> - list of allowed domains
            headers <list of strings> - list of secure request headers (Accept, Accept-Language, Content-Type, Content-Language are allowed by default)
            expose <list of strings> - list of upper level API accessible headers (Cache-Control, Content-Language, Content-Type, Expires, Last-Modified, Pragma are allowed by default)
            methods <list of strings> - list of safe methods (GET, HEAD, POST are allowed by default)
            max_age <integer> - preflight request response lifetime
            credentials <boolean> - set an Access-Control-Allow-Credentials header
        }

compress section $

        {
            brotli <boolean> - use data compression format Brotli
            gzip <boolean> - use data compression format Gzip (default: true)
        }

limitations section $

        {
            geo <list> - list of rules for limitation by countries and regions
            ip <list> - list of rules for limitation by ip addresses
            referer <list> - list of rules for limitation by referer
            useragent <list> - list of rules for limitation by useragent
        }

limitations params section

        [{
            default_action <string> - "allow" or "deny"
            exclude <list> - list of exclusions
            times <list> - list of time intervals
        }]

limitations params times section

        [{
            start <string> - start of time interval in ISO 8601-1:2019 extended format or null
            end <string> - end of time interval in ISO 8601-1:2019 extended format or null
        }]

limitations geo exclude section

        [{
            country <string> - country code in ISO 3166-1 alpha-2
            region <string> - region code in ISO 3166-2 or null
            action <string> - "deny" or "allow"
        }]

limitations referer exclude section

        [{
           referer <string> - domain name or regular expression
        }]

limitations ip exclude section

        [{
            ip <string> - IP address to exclude in CIDR notation
        }]

limitations useragent exclude section

        [{
            useragent <string> - user agent or regular expression 
        }]

locations section

        {
            key <string> - path to content: locations params <json>
        }

locations params section

        {
            headers <json> - like global section
            cache <json> - like global section
            client_cache <json> - like global section
            auth <json> - 💲 like global section
            cors <json> - like global section
            compress <json> - 💲 like global section
            ioss <boolean> - 💲 like global section
            limitations <json> - 💲 like global section
            packaging <json> - like global section
        }

packaging params section (service description)

        {
            <format> <json> - options for the video <format> from the list: mp4
        }

packaging format params section

        {
            output_protocols <list of strings> - list of formats in which the video will be distributed (HLS, MPEG-DASH)
        }

Minimal Configuration

Example of Minimal Configuration with origin example.com

        {
             "name": "example", 
             "origin": {
             "servers": {
             "example.com": {}
                }
             },    

        }

In this case CDNvideo network will cache all the static content example.com, using the default settings.

Configuring for HTTP resource

Get all resources

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/resource/http/

• Method: GET
• Headers: CDN-AUTH-TOKEN
• Response Data Type: JSON Array or JSON Object in case of error

Available query string parameters (* - required parameter):

Parameter	Description	Possible values	Default value
active	Filter by active/deactivated resource	true / false	true

Possible response codes:

Status Code	Response Data	Response Format	Description
200	All HTTP resources configured in specified account or error description	JSON	Response with list of resources or error
403	None	None	Forbidden
404	None	None	Not Found
500	None	None	Internal Server Error
503	None	None	Service Unavailable

Request example

curl -H "CDN-AUTH-TOKEN: $TOKEN" https://api.cdnvideo.ru/cdn/api/v1/<account_name>/resource/http/

Successful response example

[{"origin": {"https": false, "servers": {"test.test.te": {"backup": false, "port": 80, "weight": 1}}}, "cdn_domain": "krvdpfc0t0.a.trbcdn.net", "name": "default2", "active": true, "cache": {"consider_args": false}, "robots": {"type": "deny"}, "names": [], "id": "krvdpfc0t0"}, {"origin": {"https": false, "servers": {"test.test.tet": {"backup": false, "port": 80, "weight": 1}}}, "cdn_domain": "zm4rrn4mkt.a.trbcdn.net", "name": "default", "active": true, "cache": {"consider_args": false}, "robots": {"type": "custom", "robotsContent": "1\n"}, "names": [], "id": "zm4rrn4mkt"}]

Unsuccessful response example

{"status": "error", "message": "Not allowed method", "description": "Request is forbidden"}

Attention

To get deactivated resources, use the query parameter "active" with the value "false"

Get specific resource

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/resource/http/<resource_id>

• Method: GET
• Headers: CDN-AUTH-TOKEN
• Response Data Type: JSON Object

Available query string parameters (* - required parameter):

Parameter	Description	Possible values	Default value
active	Filter by active/deactivated resource	true / false	true

Possible response codes:

Status Code	Response Data	Response Format	Description
200	HTTP resource configured in specified account or error description	JSON	Response with resource or error
403	None	None	Forbidden
404	None	None	Not Found
500	None	None	Internal Server Error
503	None	None	Service Unavailable

Request example

curl -H "CDN-AUTH-TOKEN: $TOKEN" https://api.cdnvideo.ru/cdn/api/v1/<account_name>/resource/http/<resource_id>

Successful response example

{"origin": {"https": false, "servers": {"test.test.te": {"backup": false, "port": 80, "weight": 1}}}, "cdn_domain": "krvdpfc0t0.a.trbcdn.net", "name": "default2", "active": true, "cache": {"consider_args": false}, "robots": {"type": "deny"}, "names": [], "id": "krvdpfc0t0"}

Unsuccessful response example

{"status": "error", "message": "Invalid Token", "description": "Invalid or expired token"}

Attention

To get deactivated resource, use the query parameter "active" with the value "false"

Get specific resource status

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/status/http/<resource_id>

• Method: GET
• Headers: CDN-AUTH-TOKEN
• Response Data Type: JSON Object

Status Code	Response Data	Response Format	Description
200	HTTP resource status or error description	JSON	Response with resource status or error
403	None	None	Forbidden
404	None	None	Not Found
500	None	None	Internal Server Error
503	None	None	Service Unavailable

Response data format:

Parameter	Description	Possible values
resource	Resource ID	Resource ID from request URL
status	Resource status	"Completed" / "Processing" / "Error"
message	Status description	"" / "dns processing" / "configuration processing"

Request example

curl -H "CDN-AUTH-TOKEN: $TOKEN" https://api.cdnvideo.ru/cdn/api/v1/<account_name>/status/http/<resource_id>

Successful response example

{"resource": "<resource_id>", "status": "Completed", "message": ""}

Unsuccessful response example

{"status": "error", "message": "Invalid Token", "description": "Invalid or expired token"}

Create resource

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/resource/http/

• Method: POST
• Headers: CDN-AUTH-TOKEN
• Request Data: JSON with resource data
• Response Data Type: JSON Object

Status Code	Response Data	Response Format	Description
200	task_id, resource_id or error description	JSON	Created, id of task in global task queue or error
400	None	None	Bad Request
404	None	None	Not Found
500	None	None	Internal Server Error
503	None	None	Service Unavailable

Request example

curl -H "CDN-AUTH-TOKEN: $TOKEN"  \
  -X POST  \
  -d '{"origin": {"servers": {"<origin_host>": {"port": 80}}},  "name": "<resource_name>"}' \
  https://api.cdnvideo.ru/cdn/api/v1/<account_name>/resource/http/

Successful response example

{"status": "accept", “task_id": "20180402162358692400", "resource_id": "v7sdnx3ytm"}

Unsuccessful response example

{"status": "error", "message": "value invalid name", "description": "Json invalid name is not uniq in account <account_name>"}

Update resource

Attention

This request completely replaces the resource configuration with the data passed in the body of the PUT request.

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/resource/http/<resource_id>

• Method: PUT
• Headers: CDN-AUTH-TOKEN
• Request Data: JSON with new resource data
• Response Data Type: JSON Object

Status Code	Response Data	Response Format	Description
200	task_id or error description	None	Updated, id of task in global task queue or error
400	None	None	Bad Request
404	None	None	Not Found
500	None	None	Internal Server Error
503	None	None	Service Unavailable

Request example

curl -H "CDN-AUTH-TOKEN: $TOKEN" \
  -X PUT \
  -d '{"origin": {"servers": {"<new_origin_host>": {"port": 80}}},  "name": "<new_resource_name>"}' \
  https://api.cdnvideo.ru/cdn/api/v1/<account_name>/resource/http/<resource_id>

Successful response example

{"status": "accept", “task_id": "20180402162358692401"}

Unsuccessful response example

{"status": "error", "message": "Json invalid", "description": "Key incorrect or not found ( origin )"}

Update resource partially

Attention

This request completely replaces the resource first level fields with the data passed in the PATCH request body. The request does not change fields that have not been passed.

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/resource/http/<resource_id>

• Method: PATCH
• Headers: CDN-AUTH-TOKEN
• Request Data: JSON with new resource first-level data (keys described in the "General configuration" section)
• Response Data Type: JSON Object

Status Code	Response Data	Response Format	Description
200	task_id or error description	None	Updated, id of task in global task queue or error
400	None	None	Bad Request
404	None	None	Not Found
500	None	None	Internal Server Error
503	None	None	Service Unavailable

Request example

curl -H "CDN-AUTH-TOKEN: $TOKEN" \
  -X PATCH \
  -d '{"name": "<new_name>", "headers": {"request": {"http_req_header_name": "<new_http_req_header_name>"}, "response": {"http_req_header_name": "<new_http_req_header_name>"}}}' \
  https://api.cdnvideo.ru/cdn/api/v1/<account_name>/resource/http/<resource_id>

Successful response example

{"status": "accept", “task_id": "20180402162358692401"}

Unsuccessful response example

{"status": "error", "message": "Json invalid", "description": "headers : Invalid key : random-key"}

Deactivate resource

Attention

This request completely replaces the resource first level fields with the data passed in the PATCH request body. The request does not change fields that have not been passed.

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/resource/http/<resource_id>

• Method: PATCH
• Headers: CDN-AUTH-TOKEN
• Response Data Type: JSON Object

Status Code	Response Data	Response Format	Description
200	task_id or error description	JSON	Deactivated, id of task in global task queue or error
400	None	None	Bad Request
404	None	None	Not Found
500	None	None	Internal Server Error
503	None	None	Service Unavailable

Request example

curl -H "CDN-AUTH-TOKEN: $TOKEN" \
  -X PATCH \
  -d '{"active": false}' \
  https://api.cdnvideo.ru/cdn/api/v1/<account_name>/resource/http/<resource_id>

Successful response example

{"status": "accept", "task_id": "20180402162358692413"}

Unsuccessful response example

{"status": "error", "message": "Not allowed method", "description": "Request is forbidden"}

Activate resource

Attention

This request completely replaces the resource first level fields with the data passed in the PATCH request body. The request does not change fields that have not been passed.

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/resource/http/<resource_id>

• Method: PATCH
• Headers: CDN-AUTH-TOKEN
• Response Data Type: JSON Object

Status Code	Response Data	Response Format	Description
200	task_id or error description	JSON	Activated, id of task in global task queue or error
400	None	None	Bad Request
404	None	None	Not Found
500	None	None	Internal Server Error
503	None	None	Service Unavailable

Request example

curl -H "CDN-AUTH-TOKEN: $TOKEN" \
  -X PATCH \
  -d '{"active": true}' \
  https://api.cdnvideo.ru/cdn/api/v1/<account_name>/resource/http/<resource_id>

Successful response example

{"status": "accept", "task_id": "20180402162358692413"}

Unsuccessful response example

```json

Local authorization $

Create resource with local authorization

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/resource/http/

• Method: POST
• Headers: CDN-AUTH-TOKEN
• Request Data: JSON with resource data and local authorization parameters
• Response Data Type: JSON Object

Status Code	Response Data	Response Format	Description
200	task_id, resource_id or error description	JSON	Created, id of task in global task queue or error
400	None	None	Bad Request
404	None	None	Not Found
500	None	None	Internal Server Error
503	None	None	Service Unavailable

Request example

curl -H "CDN-AUTH-TOKEN: $TOKEN" \
  -X POST \
  -d '{"auth": {"md5": {"secret": "123", "forever": true, "anywhere": true}}, "origin": {"servers": {"<origin_host>": {"port": 80}}},  "name": "<resource_name>"}' \
  https://api.cdnvideo.ru/cdn/api/v1/<account_name>/resource/http/

Successful response example

{"status": "accept", “task_id": "20180402162358692400", "resource_id": "v7sdnx3ytm"}

Unsuccessful response example

{"status": "error", "message": "value invalid name", "description": "Json invalid name is not uniq in account <account_name>"}

Update resource local authorization

Attention

This request completely replaces the resource first level fields with the data passed in the PATCH request body. The request does not change fields that have not been passed.

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/resource/http/<resource_id>

• Method: PATCH
• Headers: CDN-AUTH-TOKEN
• Request Data: JSON with new parameters of local authorization
• Response Data Type: JSON Object

Status Code	Response Data	Response Format	Description
200	task_id or error description	None	Updated, id of task in global task queue or error
400	None	None	Bad Request
404	None	None	Not Found
500	None	None	Internal Server Error
503	None	None	Service Unavailable

Request example

curl -H "CDN-AUTH-TOKEN: $TOKEN" \
  -X PATCH \
  -d '{"auth": {"md5": {"secret": "456", "forever": true}}}' \
  https://api.cdnvideo.ru/cdn/api/v1/<account_name>/resource/http/<resource_id>

Successful response example

{"status": "accept", “task_id": "20180402162358692401"}

Unsuccessful response example

{"status": "error", "message": "Not allowed method", "description": "Request is forbidden"}

External authorization $

Create resource with external authorization

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/resource/http/

• Method: POST
• Headers: CDN-AUTH-TOKEN
• Request Data: JSON with resource data and external authorization parameters
• Response Data Type: JSON Object

Status Code	Response Data	Response Format	Description
200	task_id, resource_id or error description	JSON	Created, id of task in global task queue or error
400	None	None	Bad Request
404	None	None	Not Found
500	None	None	Internal Server Error
503	None	None	Service Unavailable

Request example

curl -H "CDN-AUTH-TOKEN: $TOKEN" \
-X POST \
-d '{"auth": {"url": "https://test.com/yourscript"}, "origin": {"servers": {"<origin_host>": {"port": 80}}},  "name": "<resource_name>"}' \
https://api.cdnvideo.ru/cdn/api/v1/<account_name>/resource/http/

Successful response example

{"status": "accept", “task_id": "20180402162358692400", "resource_id": "v7sdnx3ytm"}

Unsuccessful response example

{"status": "error", "message": "value invalid name", "description": "Json invalid name is not uniq in account <account_name>"}

Update resource external authorization

Attention

This request completely replaces the resource first level fields with the data passed in the PATCH request body. The request does not change fields that have not been passed.

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/resource/http/<resource_id>

• Method: PATCH
• Headers: CDN-AUTH-TOKEN
• Request Data: JSON with new parameters of external authorization
• Response Data Type: JSON Object

Status Code	Response Data	Response Format	Description
200	task_id or error description	None	Updated, id of task in global task queue or error
400	None	None	Bad Request
404	None	None	Not Found
500	None	None	Internal Server Error
503	None	None	Service Unavailable

Request example

curl -H "CDN-AUTH-TOKEN: $TOKEN" \
-X PATCH \
-d '{"auth": {"url": "https://test.com/yourscript2"}}' \
https://api.cdnvideo.ru/cdn/api/v1/<account_name>/resource/http/<resource_id>

Successful response example

{"status": "accept", “task_id": "20180402162358692401"}

Unsuccessful response example

{"status": "error", "message": "Not allowed method", "description": "Request is forbidden"}

Limitations $

Create resource with geo, IP, referer or useragent limitations

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/resource/http/

• Method: POST
• Headers: CDN-AUTH-TOKEN
• Request Data: JSON with resource data and limitations parameters
• Response Data Type: JSON Object

Status Code	Response Data	Response Format	Description
200	task_id, resource_id or error description	JSON	Created, id of task in global task queue or error
400	None	None	Bad Request
404	None	None	Not Found
500	None	None	Internal Server Error
503	None	None	Service Unavailable

Request example

curl -H "CDN-AUTH-TOKEN: $TOKEN" \
  -X POST \
  -d '{"origin": {"servers": {"<origin_host>": {"port": 80}}}, "name": "<resource_name>", "limitations": {"geo": [{"default_action": "allow", "exclude": [{"country": "RU", "region": "BEL", "action": "deny"}], "times": [{"start": "2019-07-20T14:17:00Z", "end": "2019-07-20T14:18:00Z"}]}, {"default_action": "allow", "exclude": [{"country": "RU", "region": "CR", "action": "deny"}, {"country": "RU", "region": null, "action": "deny"}], "times": [{"start": "2019-07-20T14:19:00Z", "end": null}]}], "ip": [{"default_action": "deny", "exclude": [{"ip":"192.168.0.1/24"}], "times": [{"start": "2019-07-20T14:17:00Z", "end": "2019-07-20T14:18:00Z"}]}], "referer": [{"default_action": "deny", "exclude": [{"referer":"*.ru"}], "times": [{"start": null, "end": "2019-07-20T14:18:00Z"}]}], "useragent": [{"default_action": "deny", "exclude": [{"useragent": "browser_name"}], "times": [{"start": "2019-07-20T14:17:00Z", "end": "2019-07-20T14:18:00Z"}]}]}}' \
  https://api.cdnvideo.ru/cdn/api/v1/<account_name>/resource/http/

Successful response example

{"status": "accept", “task_id": "20180402162358692400", "resource_id": "v7sdnx3ytm"}

Unsuccessful response example

{"status": "error", "message": "json invalid", "description": "limitations : Invalid time interval: start:2021-05-11T19:12:00Z, end:2021-05-09T22:12:00Z"}

Update resource limitations

Attention

This request completely replaces the resource first level fields with the data passed in the PATCH request body. The request does not change fields that have not been passed.

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/resource/http/<resource_id>

• Method: PATCH
• Headers: CDN-AUTH-TOKEN
• Request Data: JSON with new parameters of external authorization
• Response Data Type: JSON Object

Status Code	Response Data	Response Format	Description
200	task_id or error description	None	Updated, id of task in global task queue or error
400	None	None	Bad Request
404	None	None	Not Found
500	None	None	Internal Server Error
503	None	None	Service Unavailable

Request example

curl -H "CDN-AUTH-TOKEN: $TOKEN" \
  -X PATCH \
  -d '{"limitations": { "ip": [{"default_action": "deny", "exclude": [{"ip":"192.168.0.1/24"}], "times": []}]}}' \
  https://api.cdnvideo.ru/cdn/api/v1/<account_name>/resource/http/<resource_id>

Successful response example

{"status": "accept", “task_id": "20180402162358692401"}

Unsuccessful response example

{"status": "error", "message": "Not allowed method", "description": "Request is forbidden"}

Content distribution zones expansion $

Connection of additional distribution zones in the foreign segment of the network. You can find the geography of coverage on the network map.

Get current configuration for all resources

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/cncconfiguration/

• Method: GET
• Headers: CDN-AUTH-TOKEN
• Response Data Type: JSON Object

Status Code	Response Data	Response Format	Description
200	code: type integer, message: type string, data: type list with the object on every specific resource: [{areas: type list, certificate: type integer or empty string or null, cnc_configured: type bool, is_changes_apply: type bool, resource_id: type string}, ]	JSON	OK
401	None	None	Unauthorized
500	None	None	Internal Server Error

Possible values areas:

Value	Description
am	the USA
apac	Asia and the Pacific
emea	Europe, Middle East, Africa

Request example

curl -H "CDN-AUTH-TOKEN: $TOKEN" \
https://api.cdnvideo.ru/cdn/api/v1/cpfgdakp/cncconfiguration/

Successful response example

{
  "message": "Ok",
  "code": 200,
  "data": [
    {
    "is_changes_apply": true,
    "cnc_configured": true,
    "certificate": "",
    "areas": ["apac", "emea"],
    "resource_id": "lajjncnn6d"
    },
    {
    "is_changes_apply": true,
    "cnc_configured": false,
    "certificate": 1,
    "areas": ["am"],
    "resource_id": "ni1zohncn2"
    }
  ]
}

Get current configuration on specific resource

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/cncconfiguration/<resource_id>

• Method: GET
• Headers: CDN-AUTH-TOKEN
• Response Data Type: JSON Object

Status Code	Response Data	Response Format	Description
200	code: type integer, message: type string, data: {areas: type list, certificate: type integer or empty string or null, cnc_configured: type bool, is_changes_apply: type bool}	JSON	OK
401	None	None	Unauthorized
500	None	None	Internal Server Error

Possible values areas:

Value	Description
am	the USA
apac	Asia and the Pacific
emea	Europe, Middle East, Africa

Request example

curl -H "CDN-AUTH-TOKEN: $TOKEN" \
https://api.cdnvideo.ru/cdn/api/v1/cpfgdakp/cncconfiguration/lajjncnn6d

Successful response example

{
  "message": "Ok",
  "code": 200,
  "data": {
    "is_changes_apply": true,
    "cnc_configured": true,
    "certificate": "",
    "areas": ["apac", "emea"]
  }
}

Add/Change distribution zones $

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/cncconfiguration/<resource_id>

• Method: POST
• Headers: CDN-AUTH-TOKEN
• Request Data: JSON with configuration data
• Response Data Type: JSON Object

Request data description:

Parameter name	Value Type	Required
	JSON Object	Yes
areas	Array, one or more from ("apac", "am", "emea")	Yes
certificate	String or None	No

Possible response codes:

Status Code	Response Data	Response Format	Description
200	message: type string, code: type integer	JSON	OK
400	None	None	Bad Request
401	None	None	Unauthorized
409	None	None	Conflict (previous changes haven`t been applied yet)

Request example

curl -X POST -d '{"areas": ["apac", "emea"]}' \
-H "CDN-AUTH-TOKEN: $TOKEN" \
https://api.cdnvideo.ru/cdn/api/v1/cpfgdakp/cncconfiguration/lajjncnn6d

Successful response example

{
  "message": "Ok",
  "code": 200
}

Disable additional distribution zones

URL: https://api.cdnvideo.ru/cdn/api/v1/<your_account_name>/cncconfiguration/<resource_id>

• Method: POST
• Headers: CDN-AUTH-TOKEN
• Request Data: JSON with configuration data
• Response Data Type: JSON Object

Request data description:

Parameter name	Value Type	Required
	JSON Object	Yes
areas	Empty Array [ ]	Yes
certificate	String or None	No

Possible response codes:

Status Code	Response Data	Response Format	Description
200	message: type string, code: type integer	JSON	OK
400	None	None	Bad Request
401	None	None	Unauthorized
409	None	None	Conflict (previous changes haven`t been applied yet)

Request example

curl -X POST -d '{"areas": []}' \
-H "CDN-AUTH-TOKEN: $TOKEN" \
https://api.cdnvideo.ru/cdn/api/v1/cpfgdakp/cncconfiguration/lajjncnn6d

Successful response example

{
  "message": "Ok",
  "code": 200
}