Aller au contenu
Référence API
Référence API

Supprimer un garde-fou

Supprimer un guardrail de manière logique et retirer ses assignations.

Voir en Markdown

Supprimer un guardrail de manière logique et retirer ses assignations.

Point de terminaison

DELETE /api/v1/guardrails/:id
URL de base
https://runapi.ai
Version de l'API
v1
Authentification
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Autorisation
Nécessite une clé API de gestion d'administrateur de compte.
02

Requête

Corps JSON

Envoyez les valeurs uniquement à l'emplacement de requête indiqué.

Paramètres de chemin1 champ
idstring
Requis

Préfixe d'identifiant du guardrail, par exemple guardrail_abc123.

03

Réponse de succès

HTTP 204

DELETE /api/v1/guardrails/:id

Cette réponse n'a pas de corps.

04

Réponse d'erreur (401)

HTTP 401
Schéma de réponse
JSON 
{
  "properties": {
    "error": {
      "description": "Message d'erreur lisible par l'humain.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemple de réponse

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

Réponse d'erreur (403)

HTTP 403
Schéma de réponse
JSON 
{
  "properties": {
    "error": {
      "description": "Message d'erreur lisible par l'humain.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemple de réponse

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

Réponse d'erreur (403)

HTTP 403
Schéma de réponse
JSON 
{
  "properties": {
    "error": {
      "description": "Message d'erreur lisible par l'humain.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemple de réponse

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

Réponse d'erreur (404)

HTTP 404
Schéma de réponse
JSON 
{
  "properties": {
    "error": {
      "description": "Message d'erreur lisible par l'humain.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemple de réponse

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

Exemple cURL

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