API-Schlüssel

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

API-Schlüssel auflisten

GET /api/apikeys/{tenant}

Authentifizierung: Sitzung eines Administrators von exoCortex Core

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
tenant	Pfad	string	ja	Tenant code (case-insensitive).

Antworten

Status	Beschreibung
200	Keys of the tenant (secrets are never returned).
401	Not authenticated.
403	Authenticated but not allowed (role, tenant or key).

Beispiel 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"
    }
  ]
}

Beispiel mit curl

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

API-Schlüssel erstellen

POST /api/apikeys/{tenant}

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

Authentifizierung: Sitzung eines Administrators von exoCortex Core

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
tenant	Pfad	string	ja	Tenant code (case-insensitive).

Request-Body

application/json

Name	Typ	Pflicht	Beschreibung
name	string	nein
scopes	array<string (tickets:create, tickets:read, tickets:comment, tickets:*, *)>	nein	Scopes granted to the key. An empty list grants every v1 scope; prefer explicit scopes.

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

Antworten

Status	Beschreibung
200	Key created.
400	Invalid request.
401	Not authenticated.
403	Authenticated but not allowed (role, tenant or key).

Beispiel 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."
}

Beispiel mit 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"]}'

API-Schlüssel widerrufen

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

Authentifizierung: Sitzung eines Administrators von exoCortex Core

Parameter

Name	Ort	Typ	Pflicht	Beschreibung
tenant	Pfad	string	ja	Tenant code (case-insensitive).
keyid	Pfad	string	ja

Antworten

Status	Beschreibung
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.

Beispiel 200

{
  "ok": true
}

Beispiel mit curl

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

Seite generiert aus der OpenAPI-Spezifikation der Integrations-API, Version 1.1.0.