Chaves API

Create, list and revoke tenant-bound API keys (administrator session).

Listar as chaves API

GET /api/apikeys/{tenant}

Autenticação: Sessão de um administrador do exoCortex Core

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
tenant	caminho	string	sim	Tenant code (case-insensitive).

Respostas

Estado	Descrição
200	Keys of the tenant (secrets are never returned).
401	Not authenticated.
403	Authenticated but not allowed (role, tenant or key).

Exemplo 200

{
  "ok": true,
  "keys": [
    {
      "keyid": "9f2c4e1a7b3d",
      "name": "ERP connector",
      "scopes": [
        "tickets:create",
        "tickets:read"
      ],
      "active": true,
      "created_at": "2026-11-01T08:00:00.000Z",
      "last_used_at": "2026-11-01T09:14:05.000Z"
    }
  ]
}

Exemplo com curl

curl -X GET "https://exocortex-api.ai-exo-cortex.com/api/apikeys/ACME" \
  -H "Authorization: Bearer $EXO_ADMIN_SESSION"

Criar uma chave API

POST /api/apikeys/{tenant}

Returns the full key once. exoCortex stores only a hash of the secret.

Autenticação: Sessão de um administrador do exoCortex Core

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
tenant	caminho	string	sim	Tenant code (case-insensitive).

Corpo do pedido

application/json

Nome	Tipo	Obrigatório	Descrição
name	string	não
scopes	array<string (tickets:create, tickets:read, tickets:comment, tickets:*, *)>	não	Scopes granted to the key. An empty list grants every v1 scope; prefer explicit scopes.

{
  "name": "ERP connector",
  "scopes": [
    "tickets:create",
    "tickets:read"
  ]
}

Respostas

Estado	Descrição
200	Key created.
400	Invalid request.
401	Not authenticated.
403	Authenticated but not allowed (role, tenant or key).

Exemplo 200

{
  "ok": true,
  "key": "nhk.9f2c4e1a7b3d.0123456789abcdef0123456789abcdef0123456789abcdef",
  "keyid": "9f2c4e1a7b3d",
  "name": "ERP connector",
  "scopes": [
    "tickets:create",
    "tickets:read"
  ],
  "note": "Copia la chiave ora: non sarà più mostrata."
}

Exemplo com curl

curl -X POST "https://exocortex-api.ai-exo-cortex.com/api/apikeys/ACME" \
  -H "Authorization: Bearer $EXO_ADMIN_SESSION" \
  -H "Content-Type: application/json" \
  --data '{"name":"ERP connector","scopes":["tickets:create","tickets:read"]}'

Revogar uma chave API

DELETE /api/apikeys/{tenant}/{keyid}

Autenticação: Sessão de um administrador do exoCortex Core

Parâmetros

Nome	Onde	Tipo	Obrigatório	Descrição
tenant	caminho	string	sim	Tenant code (case-insensitive).
keyid	caminho	string	sim

Respostas

Estado	Descrição
200	Key revoked. It stops working immediately.
401	Not authenticated.
403	Authenticated but not allowed (role, tenant or key).
404	Resource not found or not configured.

Exemplo 200

{
  "ok": true
}

Exemplo com curl

curl -X DELETE "https://exocortex-api.ai-exo-cortex.com/api/apikeys/ACME/9f2c4e1a7b3d" \
  -H "Authorization: Bearer $EXO_ADMIN_SESSION"

Página gerada a partir da especificação OpenAPI da API de integração, versão 1.1.0.