Pular para o conteúdo principal

Chaves de API

As chaves de API da organização. revoke revoga uma chave em definitivo (só uma chave revogada pode ser removida com delete), e rotate emite uma sucessora e mantém a anterior funcionando por alguns dias — o segredo novo aparece uma única vez, na resposta.

ComandoHTTPDescrição
api-keys listGET /v1/api_keysListar chaves de API
api-keys createPOST /v1/api_keysCriar chave de API
api-keys getGET /v1/api_keys/{id}Consultar chave de API
api-keys updatePATCH /v1/api_keys/{id}Atualizar chave de API
api-keys deleteDELETE /v1/api_keys/{id}Remover chave revogada
api-keys revokePOST /v1/api_keys/{id}/revokeRevogar chave de API
api-keys rotatePOST /v1/api_keys/{id}/rotateRotacionar chave de API

Exemplos​

--params carrega parâmetros de query, de caminho e de cabeçalho (id, página, filtros, X-Workspace-Id); --json carrega o corpo da requisição; --fields limita os campos que voltam — vale a pena em todo list/get, para economizar contexto. Veja Flags globais para a referência completa.

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

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

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

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

Próximos passos​