تخطَّ إلى المحتوى
مرجع API
مرجع API

حذف ضابط حماية

حذف حارس بشكل مؤقت وإزالة تعيينات.

عرض Markdown

حذف حارس بشكل مؤقت وإزالة تعيينات.

نقطة النهاية

DELETE /api/v1/guardrails/:id
عنوان URL الأساسي
https://runapi.ai
إصدار API
v1
المصادقة
Authorization: Bearer YOUR_MANAGEMENT_API_KEY
التفويض
يتطلب مفتاح Management API لمسؤول الحساب.
02

الطلب

نص JSON

أرسل القيم فقط في موقع الطلب المُدرج.

معاملات المسارحقل واحد
idstring
مطلوب

معرّف بادئة Guardrail، على سبيل المثال guardrail_abc123.

03

استجابة النجاح

HTTP 204

DELETE /api/v1/guardrails/:id

لا يحتوي هذا الرد على نص.

04

استجابة الخطأ (401)

HTTP 401
مخطط الاستجابة
JSON 
{
  "properties": {
    "error": {
      "description": "رسالة خطأ قابلة للقراءة البشرية.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

مثال على الاستجابة

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

استجابة الخطأ (403)

HTTP 403
مخطط الاستجابة
JSON 
{
  "properties": {
    "error": {
      "description": "رسالة خطأ قابلة للقراءة البشرية.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

مثال على الاستجابة

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

استجابة الخطأ (403)

HTTP 403
مخطط الاستجابة
JSON 
{
  "properties": {
    "error": {
      "description": "رسالة خطأ قابلة للقراءة البشرية.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

مثال على الاستجابة

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

استجابة الخطأ (404)

HTTP 404
مخطط الاستجابة
JSON 
{
  "properties": {
    "error": {
      "description": "رسالة خطأ قابلة للقراءة البشرية.",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

مثال على الاستجابة

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

مثال cURL

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