Zum Inhalt springen
API-Referenz
API-Referenz

Einen API-Schlüssel löschen

Einen Standard-API-Schlüssel widerrufen, ohne historische Nutzungsdaten zu löschen.

Markdown anzeigen

Einen Standard-API-Schlüssel widerrufen, ohne historische Nutzungsdaten zu löschen.

Endpunkt

DELETE /api/v1/keys/:id
Basis-URL
https://runapi.ai
API-Version
v1
Authentifizierung
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Autorisierung
Erfordert einen Management-API-Schlüssel mit Kontoadministrator-Rechten und erlaubt nur Schlüssel, die dem eigenen Benutzer gehören.
02

Anfrage

JSON-Body

Werte nur am angegebenen Anfrage-Speicherort senden.

Pfadparameter1 Feld
idstring
Erforderlich

Präfix-ID des API-Schlüssels, zum Beispiel token_123.

03

Erfolgsantwort

HTTP 204

DELETE /api/v1/keys/:id

Diese Antwort hat keinen Body.

04

Fehlerantwort (401)

HTTP 401
Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "Authentication required"
}
05

Fehlerantwort (403)

HTTP 403
Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "Management API key required"
}
06

Fehlerantwort (403)

HTTP 403
Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "Account admin required"
}
07

Fehlerantwort (404)

HTTP 404
Antwort-Schema
JSON 
{
  "properties": {
    "error": {
      "description": "Für Menschen lesbare Fehlermeldung.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Antwortbeispiel

JSON 
{
  "error": "Resource not found"
}
08

cURL-Beispiel

CURL 
curl -X DELETE https://runapi.ai/api/v1/keys/token_123 \
  -H 'Authorization: Bearer YOUR_MANAGEMENT_API_KEY'