Naar inhoud springen
API-referentie
API-referentie

Een API-sleutel verwijderen

Een standaard API-sleutel intrekken zonder historische gebruiksrecords te verwijderen.

Een standaard API-sleutel intrekken zonder historische gebruiksrecords te verwijderen.

Eindpunt

DELETE /api/v1/keys/:id
Basis-URL
https://runapi.ai
API-versie
v1
Authenticatie
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Autorisatie
Vereist een Management API-sleutel met accountbeheerdersrechten en staat alleen sleutels toe die eigendom zijn van de bijbehorende gebruiker.
02

Verzoek

JSON-body

Stuur waarden alleen op de vermelde verzoeklocatie.

Padparameters1 veld
idstring
Verplicht

Prefix-ID van de API-sleutel, bijvoorbeeld token_123.

03

Succesvol antwoord

HTTP 204

DELETE /api/v1/keys/:id

Deze reactie heeft geen body.

04

Foutrespons (401)

HTTP 401
Responsschema
JSON
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

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

Foutrespons (403)

HTTP 403
Responsschema
JSON
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

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

Foutrespons (403)

HTTP 403
Responsschema
JSON
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

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

Foutrespons (404)

HTTP 404
Responsschema
JSON
{
  "properties": {
    "error": {
      "description": "Leesbare foutmelding.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Responsvoorbeeld

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

cURL-voorbeeld

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