Listar claves API

GET /v1/api-keys

Lista todas las claves API activas (no revocadas) del usuario autenticado. La respuesta nunca incluye valores de clave sin procesar ni hashes -- solo metadatos para identificación y gestión.

Pruébalo

Prueba este endpoint de forma interactiva en la Swagger UI.

Autorización requerida

Incluye tu clave API en el encabezado Authorization.

Solicitud

Encabezados

Encabezado	Valor	Requerido
Authorization	Bearer <token>	Sí

Este endpoint no acepta parámetros de consulta ni cuerpo de solicitud.

Ejemplos de código

curl

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

TypeScript

const apiKey = process.env.DOCMAP_API_KEY

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

const { data } = await response.json()

for (const key of data) {
  console.log(`${key.name} (${key.prefix}...) — created ${key.createdAt}`)
}

Python

import requests

api_key = "dm_live_abc123def456ghi789jkl012mno345"

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

keys = response.json()["data"]

for key in keys:
    print(f"{key['name']} ({key['prefix']}...) — created {key['createdAt']}")

Respuesta

Estado: 200 OK

El cuerpo de la respuesta contiene un array data de objetos de metadatos de claves API.

Campos

Cada objeto en el array contiene:

Campo	Tipo	Descripción
id	string	Identificador único de la clave API.
userId	string	ID del usuario propietario de la clave.
name	string	Etiqueta descriptiva de la clave.
prefix	string	Primeros caracteres de la clave para identificación (por ejemplo, dm_live_abc1).
expiresAt	string | null	Marca de tiempo ISO 8601 de expiración, o null si la clave nunca expira.
lastUsedAt	string | null	Marca de tiempo ISO 8601 de la última vez que se usó la clave. null si nunca se ha usado.
createdAt	string	Marca de tiempo ISO 8601 de cuándo se creó la clave.
revoked	boolean	Si la clave ha sido revocada. Siempre false en esta respuesta ya que solo se devuelven claves activas.

Ejemplo

{
  "data": [
    {
      "id": "ak_1a2b3c4d5e6f7g8h",
      "userId": "uid_a1b2c3d4e5f6",
      "name": "Production Server",
      "prefix": "dm_live_r4nd",
      "expiresAt": "2025-02-18T10:00:00.000Z",
      "lastUsedAt": "2024-11-20T16:45:00.000Z",
      "createdAt": "2024-11-20T10:00:00.000Z",
      "revoked": false
    },
    {
      "id": "ak_9i8h7g6f5e4d3c2b",
      "userId": "uid_a1b2c3d4e5f6",
      "name": "Local Development",
      "prefix": "dm_live_t3st",
      "expiresAt": null,
      "lastUsedAt": "2024-11-19T08:30:00.000Z",
      "createdAt": "2024-10-05T12:00:00.000Z",
      "revoked": false
    }
  ]
}

Errores

Estado	Código	Descripción
401	UNAUTHORIZED	Clave API / token faltante, inválido o expirado.