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

Supprimer une affectation de garde-fou

Supprimez un garde-fou de sa clé API ou de la cible d'un membre du compte.

Voir en Markdown

Supprimez un garde-fou de sa clé API ou de la cible d’un membre du compte.

Point de terminaison

DELETE /api/v1/guardrail_assignments/:id
URL de base
https://runapi.ai
Version de l'API
v1
Authentification
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Autorisation
Les administrateurs de compte peuvent supprimer n'importe quelle affectation. Les utilisateurs non administrateurs peuvent supprimer les affectations sur leurs propres clés API.
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 de l'assignation du guardrail.

03

Réponse de succès

HTTP 204

DELETE /api/v1/guardrail_assignments/: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": "Forbidden"
}
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/guardrail_assignments/guardrail_assignment_123 \
  -H 'Authorization: Bearer YOUR_MANAGEMENT_API_KEY'