Конфигурация для HTTP-ресурса

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

Тип запроса: GET
Заголовки: CDN-AUTH-TOKEN
Тип данных ответа: JSON Array или JSON Object в случае ошибки

Доступные параметры query string (* - обязательный параметр):

Название	Описание	Допустимые значения	Значение по умолчанию
active	Фильтр по активным/деактивированным ресурсам	true / false	true

Возможные коды ответа:

Код ответа	Данные ответа	Формат ответа	Описание
200	Все HTTP-ресурсы для аккаунта или описание ошибки	JSON	Получен список ресурсов или ошибка
403	None	None	Запрещено
404	None	None	Не найдено
500	None	None	Внутренняя ошибка сервера
503	None	None	Сервис недоступен

Пример запроса

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

Пример успешного ответа

[{"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"}]

Пример неуспешного ответа

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

Обратите внимание

Для получения неактивных ресурсов используйте query-параметр "active" с значением "false"

Получить конкретный ресурс

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

Тип запроса: GET
Заголовки: CDN-AUTH-TOKEN
Тип данных ответа: JSON Object

Доступные параметры query string (* - обязательный параметр):

Название	Описание	Допустимые значения	Значение по умолчанию
active	Фильтр по активным/деактивированным ресурсам	true / false	true

Возможные коды ответа:

Код ответа	Данные ответа	Формат ответа	Описание
200	Конкретный HTTP-ресурс для аккаунта или описание ошибки	JSON	Получен ресурс или ошибка
403	None	None	Запрещено
404	None	None	Не найдено
500	None	None	Внутренняя ошибка сервера
503	None	None	Сервис недоступен

Пример запроса

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

Пример успешного ответа

{"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"}

Пример неуспешного ответа

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

Обратите внимание

Для получения неактивных ресурсов используйте query-параметр "active" с значением "false"

Получить статус конкретного ресурса

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

Тип запроса: GET
Заголовки: CDN-AUTH-TOKEN
Тип данных ответа: JSON Object

Код ответа	Данные ответа	Формат ответа	Описание
200	Статус HTTP-ресурса или описание ошибки	JSON	Получен статус ресурса или ошибка
403	None	None	Запрещено
404	None	None	Не найдено
500	None	None	Внутренняя ошибка сервера
503	None	None	Сервис недоступен

Формат данных ответа:

Параметр	Описание	Возможные значения
resource	ID ресурса	ID ресурса из URL запроса
status	Статус ресурса	"Completed" / "Processing" / "Error"
message	Описание статуса	"" / "dns processing" / "configuration processing"

Пример запроса

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

Пример успешного ответа

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

Пример неуспешного ответа

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

Создать ресурс

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

Тип запроса: POST
Заголовки: CDN-AUTH-TOKEN
Тело запроса: JSON с данными создаваемого ресурса
Тип данных ответа: JSON Object

Код ответа	Данные ответа	Формат ответа	Описание
200	task_id, resource_id или описание ошибки	JSON	Создан, id задачи в общей очереди задач или ошибка
400	None	None	Неверный запрос
404	None	None	Не найдено
500	None	None	Внутренняя ошибка сервера
503	None	None	Сервис недоступен

Пример запроса

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

Пример успешного ответа

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

Пример неуспешного ответа

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

Изменить ресурс

Обратите внимание

Данный запрос полностью заменяет конфигурацию ресурса на данные, передаваемые в теле PUT запроса.

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

Тип запроса: PUT
Заголовки: CDN-AUTH-TOKEN
Тело запроса: JSON с новыми данными ресурса
Тип данных ответа: JSON Object

Код ответа	Данные ответа	Формат ответа	Описание
200	task_id или описание ошибки	None	Изменен, id задачи в общей очереди задач или ошибка
400	None	None	Неверный запрос
404	None	None	Не найдено
500	None	None	Внутренняя ошибка сервера
503	None	None	Сервис недоступен

Пример запроса

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

Пример успешного ответа

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

Пример неуспешного ответа

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

Деактивация ресурса

Обратите внимание

Данный запрос полностью заменяет конфигурацию ресурса на данные, передаваемые в теле PUT запроса.

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

Тип запроса: PUT
Заголовки: CDN-AUTH-TOKEN
Тип данных ответа: JSON Object

Код ответа	Данные ответа	Формат ответа	Описание
200	task_id или описание ошибки	JSON	Деактивирован, id задачи в общей очереди задач или ошибка
400	None	None	Неверный запрос
404	None	None	Не найдено
500	None	None	Внутренняя ошибка сервера
503	None	None	Сервис недоступен

Пример запроса

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

Пример успешного ответа

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

Пример неуспешного ответа

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

Активация ресурса

Обратите внимание

Данный запрос полностью заменяет конфигурацию ресурса на данные, передаваемые в теле PUT запроса.

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

Тип запроса: PUT
Заголовки: CDN-AUTH-TOKEN
Тип данных ответа: JSON Object

Код ответа	Данные ответа	Формат ответа	Описание
200	task_id или описание ошибки	JSON	Активирован, id задачи в общей очереди задач или ошибка
400	None	None	Неверный запрос
404	None	None	Не найдено
500	None	None	Внутренняя ошибка сервера
503	None	None	Сервис недоступен

Пример запроса

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

Пример успешного ответа

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

Пример неуспешного ответа

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

Локальная авторизация $

Создание ресурса с локальной авторизацией

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

Тип запроса: POST
Заголовки: CDN-AUTH-TOKEN
Тело запроса: JSON с данными создаваемого ресурса и параметрами локальной авторизации
Тип данных ответа: JSON Object

Код ответа	Данные ответа	Формат ответа	Описание
200	task_id, resource_id или описание ошибки	JSON	Создан, id задачи в общей очереди задач или ошибка
400	None	None	Неверный запрос
404	None	None	Не найдено
500	None	None	Внутренняя ошибка сервера
503	None	None	Сервис недоступен

Пример запроса

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://apicdn.rcloud.ru/cdn/api/v1/<account_name>/resource/http/

Пример успешного ответа

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

Пример неуспешного ответа

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

Изменение локальной авторизации ресурса

Обратите внимание

Данный запрос полностью заменяет конфигурацию ресурса на данные, передаваемые в теле PUT запроса.

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

Тип запроса: PUT
Заголовки: CDN-AUTH-TOKEN
Тело запроса: JSON с измененными параметрами локальной авторизации
Тип данных ответа: JSON Object

Код ответа	Данные ответа	Формат ответа	Описание
200	task_id или описание ошибки	None	Изменен, id задачи в общей очереди задач или ошибка
400	None	None	Неверный запрос
404	None	None	Не найдено
500	None	None	Внутренняя ошибка сервера
503	None	None	Сервис недоступен

Пример запроса

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

Пример успешного ответа

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

Пример неуспешного ответа

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

Внешняя авторизация $

Создание ресурса с внешней авторизацией

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

Тип запроса: POST
Заголовки: CDN-AUTH-TOKEN
Тело запроса: JSON с данными создаваемого ресурса и параметрами внешней авторизации
Тип данных ответа: JSON Object

Код ответа	Данные ответа	Формат ответа	Описание
200	task_id, resource_id или описание ошибки	JSON	Создан, id задачи в общей очереди задач или ошибка
400	None	None	Неверный запрос
404	None	None	Не найдено
500	None	None	Внутренняя ошибка сервера
503	None	None	Сервис недоступен

Пример запроса

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://apicdn.rcloud.ru/cdn/api/v1/<account_name>/resource/http/

Пример успешного ответа

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

Пример неуспешного ответа

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

Изменение внешней авторизации ресурса

Обратите внимание

Данный запрос полностью заменяет конфигурацию ресурса на данные, передаваемые в теле PUT запроса.

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

Тип запроса: PUT
Заголовки: CDN-AUTH-TOKEN
Тело запроса: JSON с измененными параметрами внешней авторизации
Тип данных ответа: JSON Object

Код ответа	Данные ответа	Формат ответа	Описание
200	task_id или описание ошибки	None	Изменен, id задачи в общей очереди задач или ошибка
400	None	None	Неверный запрос
404	None	None	Не найдено
500	None	None	Внутренняя ошибка сервера
503	None	None	Сервис недоступен

Пример запроса

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

Пример успешного ответа

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

Пример неуспешного ответа

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

Ограничения раздачи $

Создание ресурса с ограничением раздачи по странам, IP адресам, referer, или User-Agent

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

Тип запроса: POST
Заголовки: CDN-AUTH-TOKEN
Тело запроса: JSON с данными создаваемого ресурса и параметрами ограничений
Тип данных ответа: JSON Object

Код ответа	Данные ответа	Формат ответа	Описание
200	task_id, resource_id или описание ошибки	JSON	Создан, id задачи в общей очереди задач или ошибка
400	None	None	Неверный запрос
404	None	None	Не найдено
500	None	None	Внутренняя ошибка сервера
503	None	None	Сервис недоступен

Пример запроса

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://apicdn.rcloud.ru/cdn/api/v1/<account_name>/resource/http/

Пример успешного ответа

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

Пример неуспешного ответа

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

Изменение ограничений раздачи ресурса

Обратите внимание

Данный запрос полностью заменяет конфигурацию ресурса на данные, передаваемые в теле PUT запроса.

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

Тип запроса: PUT
Заголовки: CDN-AUTH-TOKEN
Тело запроса: JSON с измененными параметрами ограничений
Тип данных ответа: JSON Object

Код ответа	Данные ответа	Формат ответа	Описание
200	task_id или описание ошибки	None	Изменен, id задачи в общей очереди задач или ошибка
400	None	None	Неверный запрос
404	None	None	Не найдено
500	None	None	Внутренняя ошибка сервера
503	None	None	Сервис недоступен

Пример запроса

curl -H "CDN-AUTH-TOKEN: $TOKEN" \
-X PUT \
-d '{"origin": {"servers": {"<origin_host>": {"port": 80}}}, "name": "<resource_name>", "limitations": { "ip": [{"default_action": "deny", "exclude": [{"ip":"192.168.0.1/24"}], "times": []}]}}' \
https://apicdn.rcloud.ru/cdn/api/v1/<account_name>/resource/http/<resource_id>

Пример успешного ответа

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

Пример неуспешного ответа

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

Дерево страниц

Конфигурация для HTTP-ресурса

Получить конкретный ресурс

Получить статус конкретного ресурса

Создать ресурс

Изменить ресурс

Деактивация ресурса

Активация ресурса

Локальная авторизация $

Внешняя авторизация $

Ограничения раздачи $