Undeploy Guardrails API¶

This API removes the previously deployed guardrails that regulate AI interactions.

Once undeployed, the guardrails become inactive. The API response includes the model ID and the guardrail undeployment status. After receiving the response, use the dockStatusId to call the Get Dock Status API and verify the guardrail undeployment status.

Method	POST
Endpoint	`https://{host}/api/public/guardrails/undeploy`
Content Type	application/json
Authorization	`X-api-key` - The API key used for authentication.

Where can I find the API key?

To use the API, you will need an API key. Learn more.

Path Parameters¶

PARAMETER	DESCRIPTION	TYPE	REQUIRED/OPTIONAL	ENUM VALUES
host	The environment URL. For example, `https://agent-platform.domain.ai/`	String	Required	The allowed guardrails include: Anonymize – Ensures sensitive information is anonymized. Ban topics – Restricts discussions on specific topics. Prompt injection – Prevents unauthorized prompt manipulation. Toxicity – Detects and filters toxic language. Bias detection – Identifies and mitigates biased responses. Relevance – Ensures responses stay relevant to the conversation

Sample Request¶

curl --location 'https://{host}/api/public/guardrails/undeploy' 
--header 'x-api-key: kg-axxxxxxx-xxxx-5xx8-bxxb-9xxxxxxxxxx-ebxxxxxx-5xxb-4xxb-9xx5-cxxxxxxxxx3' 
--header 'Content-Type: application/json' 
--data '{"name": "Ban topics"}'

Body Parameters¶

PARAMETER	DESCRIPTION	TYPE	REQUIRED/OPTIONAL
name	Name of the guardrail you want to undeploy.	Enum	Required

Sample Response¶

{
   "dockStatusId": "ds-exxxxxx7-2xx8-5xxc-axx7-caxxxxxxxxx1",
   "toolId": "a-4xxxxxx9-fxx9-5xx7-axx7-9xxxxxxxxxxb",
   "jobType": "GUARDRAILS",
   "action": "DEPLOY",
   "status": "SUCCESS"
}

Response Parameters¶

PARAMETER	DESCRIPTION	TYPE
dockStatusId	The unique identifier to track the process status.	String
guardrail	The guardrail you want to undeploy.	String
jobType	Type of job being performed. (e.g., "GUARDRAIL").	String
action	The action performed on the guardrail, i.e. “UNDEPLOY.”.	String
status	The current status of the job ("SUCCESS", "IN_PROGRESS", or "FAILED").	String

Send Feedback