Skip to navigation

Update Blocklist Rule

Update the fields you send. A list you send replaces the whole list.

Authentication

AuthorizationBearer

A management key (mgmt_...), sent as Authorization: Bearer <key>. Reading /v1/routing-policies also accepts the organization’s gateway API keys; writing there needs a management key.

Path parameters

rule_idstringRequiredformat: "uuid"

The rule’s id.

Request

This endpoint expects an object.
customer_idslist of strings or nullOptional

Values of the X-Customer-ID request header the rule applies to. Empty matches every customer. Omit, or send null, to keep the current value.

modelslist of strings or nullOptional

Full model ids, like openai/gpt-5.5. Omit, or send null, to keep the current value.

providerslist of strings or nullOptional

Model providers, the prefix of a model id, like anthropic. With models empty too, matches every model. Omit, or send null, to keep the current value.

reasonstring or nullOptional<=500 characters
Why the rule exists, such as a ticket or contract clause. Omit, or send null, to keep the current value.
rule_typeenum or nullOptional

block denies a request when its customer matches and its model or provider matches. pin lets the listed customers use only the listed providers and models, and needs customer_ids plus providers or models. A block always wins over a pin. Omit, or send null, to keep the current value.

Allowed values:

Response

The updated blocklist rule
created_atdatetimeRead-only
When the rule was created.
customer_idslist of strings

Values of the X-Customer-ID request header the rule applies to. Empty matches every customer.

idstringRead-onlyformat: "uuid"
The rule's id.
modelslist of strings

Full model ids, like openai/gpt-5.5.

providerslist of strings

Model providers, the prefix of a model id, like anthropic. With models empty too, matches every model.

reasonstring
Why the rule exists, such as a ticket or contract clause.
rule_typeenum

block denies a request when its customer matches and its model or provider matches. pin lets the listed customers use only the listed providers and models, and needs customer_ids plus providers or models. A block always wins over a pin.

Allowed values:
updated_atdatetimeRead-only
When the rule last changed.

Errors

401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error