Revocar clave API

DELETE /v1/api-keys/{id}

Revoca una clave API de forma inmediata. Una vez revocada, cualquier solicitud que use esta clave será rechazada con un error 401 UNAUTHORIZED.

Pruébalo

Prueba este endpoint de forma interactiva en la Swagger UI.

Autorización requerida

Incluye tu clave API en el encabezado Authorization.

DANGER

La revocación de una clave es inmediata y permanente. Cualquier sistema que use esta clave perderá el acceso de forma inmediata. Esta acción no se puede deshacer -- necesitarás crear una nueva clave y actualizar tus sistemas.

Solicitud

Encabezados

Encabezado	Valor	Requerido
Authorization	Bearer <token>	Sí

Parámetros de ruta

Parámetro	Tipo	Requerido	Descripción
id	string	Sí	El ID de la clave API a revocar (por ejemplo, ak_1a2b3c4d5e6f7g8h).

Ejemplos de código

curl

curl -X DELETE https://api.docmap.io/v1/api-keys/ak_1a2b3c4d5e6f7g8h \
  -H "Authorization: Bearer dm_live_abc123def456ghi789jkl012mno345"

TypeScript

const apiKey = process.env.DOCMAP_API_KEY
const keyId = 'ak_1a2b3c4d5e6f7g8h'

const response = await fetch(
  `https://api.docmap.io/v1/api-keys/${keyId}`,
  {
    method: 'DELETE',
    headers: { 'Authorization': `Bearer ${apiKey}` },
  },
)

const result = await response.json()
console.log(result) // { success: true }

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"
key_id = "ak_1a2b3c4d5e6f7g8h"

response = requests.delete(
    f"https://api.docmap.io/v1/api-keys/{key_id}",
    headers={"Authorization": f"Bearer {api_key}"},
)

print(response.json())  # {"success": True}

Respuesta

Estado: 200 OK

Ejemplo

{
  "success": true
}

Errores

Estado	Código	Descripción
401	UNAUTHORIZED	Clave API / token faltante, inválido o expirado.
403	FORBIDDEN	La clave API pertenece a un usuario diferente. Solo puedes revocar tus propias claves.
404	NOT_FOUND	No se encontró ninguna clave API con el ID especificado.