GET
/
guardrails
/
{guardrailId}
Get a specific guardrail
curl --request GET \
  --url https://api.portkey.ai/v1/guardrails/{guardrailId} \
  --header 'x-portkey-api-key: <api-key>'
{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "organisation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "active",
  "created_at": "2023-11-07T05:31:56Z",
  "last_updated_at": "2023-11-07T05:31:56Z",
  "owner_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "updated_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "checks": [
    {
      "id": "default.jwt",
      "parameters": {
        "jwksUri": "<string>",
        "headerKey": "<string>",
        "cacheMaxAge": 86400,
        "clockTolerance": 5,
        "maxTokenAge": "1d",
        "algorithms": [
          "RS256"
        ]
      },
      "name": "<string>",
      "enabled": true
    }
  ],
  "actions": {
    "onFail": "block",
    "onPass": "continue",
    "message": "<string>",
    "logLevel": "info",
    "metadata": {}
  }
}

Authorizations

​
x-portkey-api-key
string
header
required

Path Parameters

​
guardrailId
string
required

Guardrail UUID or slug (with guard_ prefix)

Response

200
application/json

Guardrail details retrieved successfully

The response is of type object.