Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 10 Next »

Данный ресурс предназначен для создания и управления доменами и их псевдонимами.

Описание полей ресурса Домен (Domain)

Имя

Тип

Описание

Обязательное

Значение по умолчанию

name

string

Доменное имя. Не может быть изменено после создания домена.

да


domain_prefix

string

Уникальный префикс домена, должен представлять из себя стороку из 5 цифр

да


comment

string

Комментарий

нет

null
id

integer

Уникальный идентификатор домена. Поле только для чтения.

-

-

Описание полей ресурса Псевдоним домена (Domain Alias)

Имя

Тип

ОписаниеОбязательноеЗначение по умолчанию

name

string

Псевдоним домена. Может быть IP-адресом домена.да

comment

string

Комментарий

нет

null

id

integer

Уникальный идентификатор алиаса домена. Поле только для чтения.

-

-

Описание полей ресурса Domain Force Destination

ИмяТипОписаниеОбязательноеЗначение по умолчанию

ip

string

IP-адресда

comment

string

Комментарий

нет

null

id

integer

Уникальный идентификатор алиаса домена. Поле только для чтения.

-

-

Описание полей ресурса Domain Force Source

ИмяТипОписаниеОбязательноеЗначение по умолчанию

ip

string

IP-адресда

comment

string

Комментарий

нет

null

id

integer

Уникальный идентификатор алиаса домена. Поле только для чтения.

-

-

Ресурсы раздела "Администратор"

POST /admin/domain/

Добавить домен

Параметры JSON

Имя

Тип

Обязательный

comment

string

нет

domain_prefix

string

да

name

string

да

Поля ответа

Имя

Тип

comment

string

domain_prefix

string

id

integer

name

string

GET /admin/domain/

Получить список доменов

Параметры запроса

Имя

Тип

comment

array [string]

domain_prefix

array [string]

id

array [integer]

name

array [string]

Поля ответа

Имя

Тип

comment

string

domain_prefix

string

id

integer

name

string

PUT /admin/domain/{domain_id}

Обновить домен

Параметры URL

Имя

Тип

domain_id

integer

Параметры JSON

Имя

Тип

Обязательный

comment

string

нет

Поля ответа

Имя

Тип

comment

string

domain_prefix

string

id

integer

name

string

GET /admin/domain/{domain_id}

Получить домен по его идентификатору

Параметры URL

Имя

Тип

domain_id

integer

Поля ответа

Имя

Тип

comment

string

domain_prefix

string

id

integer

name

string

DELETE /admin/domain/{domain_id}

Удалить домен

Параметры URL

Имя

Тип

domain_id

integer

POST /admin/domain/{domain_id}/alias/

Добавить псевдоним домена

Параметры URL

Имя

Тип

domain_id

integer

Параметры JSON

Имя

Тип

Обязательный

comment

string

нет

name

string

да

Поля ответа

Имя

Тип

comment

string

id

integer

name

string

GET /admin/domain/{domain_id}/alias/

Получить список псевдонимов домена

Параметры URL

Имя

Тип

domain_id

integer

Поля ответа

Имя

Тип

comment

string

id

integer

name

string

PUT /admin/domain/{domain_id}/alias/{id}

Обновить псевдоним домена

Параметры URL

Имя

Тип

domain_id

integer

id

integer

Параметры JSON

Имя

Тип

Обязательный

comment

string

нет

name

string

нет

Поля ответа

Имя

Тип

comment

string

id

integer

name

string

GET /admin/domain/{domain_id}/alias/{id}

Получить псевдоним домена по его идентификатору

Параметры URL

Имя

Тип

domain_id

integer

id

integer

Поля ответа

Имя

Тип

comment

string

id

integer

name

string

DELETE /admin/domain/{domain_id}/alias/{id}

Удалить псевдоним домена

Параметры URL

Имя

Тип

domain_id

integer

id

integer

POST /admin/domain/{domain_id}/force_dst/

Добавить domain force dst

Параметры URL

Имя

Тип

domain_id

integer

Параметры JSON

Имя

Тип

Обязательный

comment

string

нет

ip

string

да

Поля ответа

Имя

Тип

comment

string

ip

string

id

integer

GET /admin/domain/{domain_id}/force_dst/

Получить domain aliases list

Параметры URL

Имя

Тип

domain_id

integer

Поля ответа

Имя

Тип

comment

string

ip

string

id

integer

PUT /admin/domain/{domain_id}/force_dst/{id}

Обновить domain force dst

Параметры URL

Имя

Тип

domain_id

integer

id

integer

Параметры JSON

Имя

Тип

Обязательный

comment

string

нет

Поля ответа

Имя

Тип

comment

string

ip

string

id

integer

GET /admin/domain/{domain_id}/force_dst/{id}

Получить domain force dst

Параметры URL

Имя

Тип

domain_id

integer

id

integer

Поля ответа

Имя

Тип

comment

string

ip

string

id

integer

DELETE /admin/domain/{domain_id}/force_dst/{id}

Удалить domain force dst

Параметры URL

Имя

Тип

domain_id

integer

id

integer

POST /admin/domain/{domain_id}/force_src/

Добавить domain force src

Параметры URL

Имя

Тип

domain_id

integer

Параметры JSON

Имя

Тип

Обязательный

comment

string

нет

ip

string

да

Поля ответа

Имя

Тип

comment

string

ip

string

id

integer

GET /admin/domain/{domain_id}/force_src/

Получить domain aliases list

Параметры URL

Имя

Тип

domain_id

integer

Поля ответа

Имя

Тип

comment

string

ip

string

id

integer

PUT /admin/domain/{domain_id}/force_src/{id}

Обновить domain force src

Параметры URL

Имя

Тип

domain_id

integer

id

integer

Параметры JSON

Имя

Тип

Обязательный

comment

string

нет

Поля ответа

Имя

Тип

comment

string

ip

string

id

integer

GET /admin/domain/{domain_id}/force_src/{id}

Получить domain force src

Параметры URL

Имя

Тип

Имя

Тип

domain_id

integer

id

integer

Поля ответа

Имя

Тип

comment

string

ip

string

id

integer

DELETE /admin/domain/{domain_id}/force_src/{id}

Удалить domain force src

Параметры URL

Имя

Тип

domain_id

integer

id

integer

  • No labels