Archives a guardrail by its ID. To list archived guardrails, set only_archived to true in List guardrails.

When to use it

Use it to retire a guardrail you may want to restore later with Unarchive a guardrail. Deleting a guardrail cannot be undone, so archive it when you are not sure.

Required parameters

• guardrail_id (path): the ID of the guardrail.

Example request

Archive the guardrail GUARDRAIL_ID:

curl -X POST "https://api.superwise.ai/v1/guardrails/GUARDRAIL_ID/archive" \
  -H "Authorization: Bearer YOUR_TOKEN"

Replace YOUR_TOKEN with a bearer token. Creating a bearer token shows how to get one from the client ID and secret key you create in Generate access token. The guardrail then appears in List guardrails only when only_archived is true.

Response

A successful call returns 200 OK. The response body is not documented.

Related: Unarchive a guardrail, List guardrails, Delete a guardrail, Run a bulk action on guardrails