Vai al contenuto
Riferimento API
Riferimento API

Elimina un guardrail

Elimina temporaneamente un guardrail e rimuove le sue assegnazioni.

Visualizza Markdown

Elimina temporaneamente un guardrail e rimuove le sue assegnazioni.

Endpoint

DELETE /api/v1/guardrails/:id
URL di base
https://runapi.ai
Versione API
v1
Autenticazione
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Autorizzazione
Richiede una Chiave API di gestione con ruolo account-admin.
02

Richiesta

Corpo JSON

Invia i valori solo nella posizione di richiesta elencata.

Parametri del percorso1 campo
idstring
Obbligatorio

ID prefisso del Guardrail, ad esempio guardrail_abc123.

03

Risposta di successo

HTTP 204

DELETE /api/v1/guardrails/:id

Questa risposta non ha corpo.

04

Risposta di errore (401)

HTTP 401
Schema della risposta
JSON 
{
  "properties": {
    "error": {
      "description": "Messaggio di errore leggibile.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Esempio di risposta

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

Risposta di errore (403)

HTTP 403
Schema della risposta
JSON 
{
  "properties": {
    "error": {
      "description": "Messaggio di errore leggibile.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Esempio di risposta

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

Risposta di errore (403)

HTTP 403
Schema della risposta
JSON 
{
  "properties": {
    "error": {
      "description": "Messaggio di errore leggibile.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Esempio di risposta

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

Risposta di errore (404)

HTTP 404
Schema della risposta
JSON 
{
  "properties": {
    "error": {
      "description": "Messaggio di errore leggibile.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Esempio di risposta

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

Esempio cURL

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