API 키 폐기 | ToAPIs Documentation

DELETE

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

중국 본토 사용자 안내: 중국 본토 사용자는 https://api.toapis.cn 를 API 엔드포인트(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- 비밀 키가 아닙니다.

본문과 쿼리 매개변수는 허용하지 않습니다.

요청 예제

요청 예시

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
}