API Reference

API Gateway

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Configurations

Retrieve information about specific configuration properties

api_gateway.configurations.get(ConfigurationGetParams**kwargs) -> Configuration

GET/zones/{zone_id}/api_gateway/configuration

Update configuration properties

api_gateway.configurations.update(ConfigurationUpdateParams**kwargs) -> Configuration

PUT/zones/{zone_id}/api_gateway/configuration

ModelsExpand Collapse

class Configuration: …

auth_id_characteristics: List[AuthIDCharacteristic]

One of the following:

class AuthIDCharacteristicAPIShieldAuthIDCharacteristic: …

Auth ID Characteristic

name: str

The name of the characteristic field, i.e., the header or cookie name.

maxLength128

type: Literal["header", "cookie"]

The type of characteristic.

One of the following:

"header"

"cookie"

class AuthIDCharacteristicAPIShieldAuthIDCharacteristicJWTClaim: …

Auth ID Characteristic extracted from JWT Token Claims

name: str

Claim location expressed as $(token_config_id):$(json_path), where token_config_id is the ID of the token configuration used in validating the JWT, and json_path is a RFC 9535 JSONPath (https://goessner.net/articles/JsonPath/, https://www.rfc-editor.org/rfc/rfc9535.html). The JSONPath expression may be in dot or bracket notation, may only specify literal keys or array indexes, and must return a singleton value, which will be interpreted as a string.

maxLength128

type: Literal["jwt"]

The type of characteristic.