Отозвать API-ключ | ToAPIs Documentation

DELETE

/api/v1/api-keys/{api_key_id}

Для пользователей из материкового Китая: используйте https://api.toapis.cn в качестве эндпоинта (Base URL). Замените https://api.toapis.com на https://api.toapis.cn во всех примерах этого документа.

Поведение

Отзывает неиспользуемый модельный ключ, немедленно отключая его секрет. Отзыв — мягкое удаление и необратим, но историческая привязка расхода сохраняется, баланс аккаунта не обнуляется, а уже запущенные ключом задачи не отменяются.

При успехе возвращается HTTP 200 и data=null; повторный отзыв того же своего ключа также даёт 200. Чужой или несуществующий ключ возвращает 404.

Аутентификация

Authorizationstringзаголовокобязательно

Используйте Bearer YOUR_SYSTEM_ACCESS_TOKEN. Ключ модели не подходит, X-User-Id не нужен. См. правила доступа.

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

api_key_idstringпутьобязательно

Десятичный строковый ID собственного обычного ключа, не секрет sk-.

Тело и query-параметры не принимаются.

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

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

curl --request DELETE \
  --url 'https://api.toapis.com/api/v1/api-keys/43' \
  --header 'Authorization: Bearer YOUR_SYSTEM_ACCESS_TOKEN'

import requests

response = requests.delete(
    "https://api.toapis.com/api/v1/api-keys/43",
    headers={"Authorization": "Bearer YOUR_SYSTEM_ACCESS_TOKEN"},
    timeout=30,
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.toapis.com/api/v1/api-keys/43", {
  method: "DELETE",
  headers: { Authorization: "Bearer YOUR_SYSTEM_ACCESS_TOKEN" },
  signal: AbortSignal.timeout(30_000),
});
if (!response.ok) {
  throw new Error(`HTTP ${response.status}: ${await response.text()}`);
}
console.log(await response.json());

Поля ответа

Примеры содержат вымышленные данные. Метаданные описаны в деталях ключа, общий контракт и ошибки в подключении.

Примеры ответов

Пример ответа

{
  "code": 0,
  "message": "",
  "data": null
}