Saltar al contenido principal

Claves de API

Las claves de API de la organización. revoke revoca una clave para siempre (solo una clave revocada puede eliminarse con delete), y rotate emite una sucesora y mantiene la anterior funcionando por algunos días — el secreto nuevo aparece una sola vez, en la respuesta.

ComandoHTTPDescripción
api-keys listGET /v1/api_keysListar claves de API
api-keys createPOST /v1/api_keysCrear clave de API
api-keys getGET /v1/api_keys/{id}Consultar clave de API
api-keys updatePATCH /v1/api_keys/{id}Actualizar clave de API
api-keys deleteDELETE /v1/api_keys/{id}Eliminar clave revocada
api-keys revokePOST /v1/api_keys/{id}/revokeRevocar clave de API
api-keys rotatePOST /v1/api_keys/{id}/rotateRotar clave de API

Ejemplos​

--params lleva parámetros de query, de ruta y de encabezado (id, página, filtros, X-Workspace-Id); --json lleva el cuerpo de la solicitud; --fields limita los campos que vuelven — vale la pena en todo list/get, para ahorrar contexto. Mira Flags globales para la referencia completa.

# Listar claves de API
kobana dashboards api-keys list \
--params '{"status": "active"}' \
--fields "id,name,prefix,status,expires_at"

# Crear clave de API
kobana dashboards api-keys create \
--json '{"name": "Integração ERP", "expires_at": "2027-10-01T00:00:00Z"}'

# Rotar clave de API
kobana dashboards api-keys rotate \
--params '{"id": "API_KEY_ID"}' \
--json '{"grace_days": 7}'

# Revocar clave de API
kobana dashboards api-keys revoke --params '{"id": "API_KEY_ID"}' --dry-run

Próximos pasos​