Skip to main content
PATCH
Update a policy

Authorizations

Authorization
string
header
required

Telnyx API key

Path Parameters

instance_id
string<uuid>
required

The Agent Gateway's id.

name
string
required

The policy's name.

Body

application/json

A field left out stays as it is. guardrails and pipeline are replaced whole, and model: null removes the condition. The name cannot change.

description
string | null

What the policy is for.

base
string | null

A policy this one builds on, by name. The policy starts with the base's guardrails.

guardrails
object

The guardrails a policy adds to its base's, and the ones it removes from them, by name.

model
string | null

A condition on the model, by name or regular expression. The policy's guardrails run only on requests for a matching model. null matches every model.

pipeline
object | null

Ordered steps, in place of the guardrails running independently.

Response

The updated policy

data
object
required

A named set of guardrails.