API-Schlüssel

Listen Sie Ihre API-Schlüssel auf, erstellen Sie einen auf bestimmte Projekte beschränkten Schlüssel, zum Beispiel einen pro Kundenprojekt, und widerrufen Sie einen Schlüssel. Diese Endpunkte erfordern einen kontoweiten Schlüssel mit dem Zugriffsumfang read_write.

GET/api_keys

Ihre API-Schlüssel, die neuesten zuerst, einschließlich widerrufener Schlüssel, jeweils mit name, dem sichtbaren prefix, scope, project_ids (leer bei einem kontoweiten Schlüssel), last_used_at und revoked_at. Das geheime Token ist nie enthalten. Auch in Tarifen unterhalb von Scale verfügbar, damit sich bestehende Schlüssel weiterhin widerrufen lassen.

Parameter:
  • page
  • per_pageStandard: 20, maximal 100

POST/api_keys

Erstellt einen Schlüssel, der auf die Projekte in project_ids beschränkt ist und derselben Person gehört wie der aufrufende Schlüssel. Das geheime Token im Feld token wird nur in dieser Antwort zurückgegeben. Speichern Sie es daher. Der Schlüssel erhält nie Zugriff auf andere Projekte, und dieser Endpunkt erstellt nie einen kontoweiten Schlüssel. Nennt die Anfrage ein Projekt, auf das Sie keinen Zugriff haben, wird ERR_PROJECT_NOT_FOUND zurückgegeben. Haben Sie bereits 500 aktive Schlüssel, wird ERR_LIMIT_REACHED zurückgegeben, bis Sie einen davon widerrufen. Verfügbar ab Tarif Scale.

Anfragetext (JSON):
  • nameerforderlich, bis zu 100 Zeichen
  • project_idserforderlich, mindestens eine Projekt-ID
  • scopestandardmäßig read, alternativ read_write

DELETE/api_keys/:id

Widerruft einen Ihrer Schlüssel: Er funktioniert ab sofort nicht mehr und lässt sich nicht wiederherstellen. Ein erneuter Widerruf ändert nichts. Auch in Tarifen unterhalb von Scale verfügbar.

Pfad:
  • :idID des Schlüssels aus GET /api_keys

Gibt für den Schlüssel einer anderen Person ERR_NOT_FOUND zurück.