Skip to content

API Keys

Betreut von: Aether365 Team Zielgruppe: Entwickler Umfang: API-Key-Verwaltungsendpunkte

API Keys werden verwendet, um Anfragen an die REST API ohne Benutzersitzung zu authentifizieren.

Jeder API Key ist an das Tenant-Konto gebunden, das ihn erstellt hat. API Keys haben denselben Zugriff wie ein Teammitglied - sie können alle Tenant-Daten lesen und schreiben, aber keine Abrechnungs- oder Planeinstellungen ändern.

API Keys auflisten

Gibt alle aktiven API Keys für den Tenant zurück.

GET /tenants/me/api-keys

INFO

Aus Sicherheitsgründen wird der vollständige Schlüsselwert nur einmal zurückgegeben - zum Zeitpunkt der Erstellung. Nachfolgende Listenabfragen zeigen nur das Schlüsselpräfix und Metadaten.

Beispielanfrage

bash
curl https://api.aether365.io/tenants/me/api-keys \
  -H "Authorization: Bearer <token>"

Beispielantwort

json
{
  "success": true,
  "data": [
    {
      "id": "key_abc123",
      "name": "CI pipeline",
      "prefix": "ae_live_abc1",
      "createdAt": "2026-03-01T09:00:00Z",
      "lastUsedAt": "2026-04-10T14:23:00Z"
    }
  ]
}

Antwortfelder

FeldTypBeschreibung
idstringSchlüsselkennung
namestringAnzeigename
prefixstringErste 12 Zeichen des Schlüssels (zur Identifizierung)
createdAtstringISO 8601-Zeitstempel
lastUsedAtstring oder nullISO 8601-Zeitstempel der letzten authentifizierten Anfrage

Einen API Key erstellen

Erstellt einen neuen API Key. Der vollständige Schlüsselwert wird einmal zurückgegeben und kann nicht erneut abgerufen werden.

POST /tenants/me/api-keys

Anfragekörper

json
{
  "name": "CI pipeline"
}
FeldTypErforderlichBeschreibung
namestringJaAnzeigename für den Schlüssel

Beispielanfrage

bash
curl -X POST https://api.aether365.io/tenants/me/api-keys \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"name": "CI pipeline"}'

Beispielantwort

json
{
  "success": true,
  "data": {
    "id": "key_abc123",
    "name": "CI pipeline",
    "key": "ae_live_abc123xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
    "prefix": "ae_live_abc1",
    "createdAt": "2026-04-12T10:00:00Z",
    "lastUsedAt": null
  }
}

Schlüssel sofort speichern

Das key-Feld wird nur in dieser Antwort zurückgegeben. Es kann später nicht erneut abgerufen werden. Speichern Sie ihn sofort in einem Geheimnismanager (GitHub Actions Secrets, HashiCorp Vault usw.).


Einen API Key löschen

Widerruft einen API Key dauerhaft. Alle Anfragen mit diesem Schlüssel geben sofort 401 zurück.

DELETE /tenants/me/api-keys/{keyId}

Beispielanfrage

bash
curl -X DELETE https://api.aether365.io/tenants/me/api-keys/key_abc123 \
  -H "Authorization: Bearer <token>"

Beispielantwort

json
{
  "success": true,
  "data": null
}

Einen API Key verwenden

Übergeben Sie den API Key als Bearer-Token im Authorization-Header:

bash
curl https://api.aether365.io/tenants/me/scans \
  -H "Authorization: Bearer ae_live_abc123xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"

API Keys funktionieren genauso wie Sitzungstoken für alle Endpunkte. Sie laufen nicht ab, aber Sie können sie rotieren, indem Sie einen neuen Schlüssel erstellen und den alten löschen.

Ratenlimits

Die API ist auf 120 Anfragen pro Minute pro API Key begrenzt. Anfragen, die das Ratenlimit überschreiten, erhalten eine 429 Too Many Requests-Antwort. Die Antwort enthält einen Retry-After-Header, der angibt, wann Sie es erneut versuchen können.

War diese Seite hilfreich?