Удаление ключа доступа в тенанте
Метод и конечная точка
DELETE /tenants/{tenant_name}/domains/{domain}/promo_codes/{promo_code}
Описание
Позволяет удалить указанный ключ доступа.
Параметры
Параметры для метода указаны в таблице.
| Название | Обязательный | Тип данных | Описание |
|---|---|---|---|
| promo_code | да | string | Ключ доступа, подлежащий удалению |
| tenant_name | да | string | Имя тенанта |
| domain | да | string | Домен, в котором сгенерированы ключи доступа |
Запрос
curl -X 'DELETE' $LOGIN_TOKEN \
"https://admin[-<ENV>].<DEFAULT_DOMAIN>/adminapi/\
tenants/<TENANT_NAME>/domains/<DOMAIN>/promo_codes" \
-d promo_codes='{"count": <COUNT>, "lifespan": <LIFESPAN>, "output": <OUTPUT>}' \
-H 'accept: application/json'
где:
<TENANT_NAME>— имя тенанта;<DOMAIN>— домен, в котором выданы ключи доступа;<PROMO_CODE>— удаляемый ключ доступа.
Ответ
Возможные варианты ответов:
- 200 — Success — Успешно. Пример вывода:
{
"promo_codes": [
"string",
]
}
- 404 — Tenant not found — Тенант не найден. Пример вывода:
{
"message": "string"
}