Pular para o conteúdo
Referência de API
Referência de API

Excluir uma proteção

Excluir logicamente um guardrail e remover suas atribuições.

Ver Markdown

Excluir logicamente um guardrail e remover suas atribuições.

Endpoint

DELETE /api/v1/guardrails/:id
URL base
https://runapi.ai
Versão da API
v1
Autenticação
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
Autorização
Requer uma chave de API de gerenciamento de administrador de conta.
02

Solicitação

Corpo JSON

Envie valores apenas no local de requisição listado.

Parâmetros de caminho1 campo
idstring
Obrigatório

ID de prefixo do guardrail, por exemplo guardrail_abc123.

03

Resposta de sucesso

HTTP 204

DELETE /api/v1/guardrails/:id

Esta resposta não tem corpo.

04

Resposta de erro (401)

HTTP 401
Esquema de resposta
JSON 
{
  "properties": {
    "error": {
      "description": "Mensagem de erro legível por humanos.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemplo de resposta

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

Resposta de erro (403)

HTTP 403
Esquema de resposta
JSON 
{
  "properties": {
    "error": {
      "description": "Mensagem de erro legível por humanos.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemplo de resposta

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

Resposta de erro (403)

HTTP 403
Esquema de resposta
JSON 
{
  "properties": {
    "error": {
      "description": "Mensagem de erro legível por humanos.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemplo de resposta

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

Resposta de erro (404)

HTTP 404
Esquema de resposta
JSON 
{
  "properties": {
    "error": {
      "description": "Mensagem de erro legível por humanos.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

Exemplo de resposta

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

Exemplo de cURL

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