Configurations

Retrieve information about specific configuration properties

client.APIGateway.Configurations.Get(ctx, params) (*Configuration, error)

GET/zones/{zone_id}/api_gateway/configuration

Update configuration properties

client.APIGateway.Configurations.Update(ctx, params) (*Configuration, error)

PUT/zones/{zone_id}/api_gateway/configuration

ModelsExpand Collapse

type Configuration struct{…}

AuthIDCharacteristics []ConfigurationAuthIDCharacteristic

One of the following:

type ConfigurationAuthIDCharacteristicsAPIShieldAuthIDCharacteristic struct{…}

Auth ID Characteristic

Name string

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

maxLength128

Type ConfigurationAuthIDCharacteristicsAPIShieldAuthIDCharacteristicType

The type of characteristic.

One of the following:

const ConfigurationAuthIDCharacteristicsAPIShieldAuthIDCharacteristicTypeHeader ConfigurationAuthIDCharacteristicsAPIShieldAuthIDCharacteristicType = "header"

const ConfigurationAuthIDCharacteristicsAPIShieldAuthIDCharacteristicTypeCookie ConfigurationAuthIDCharacteristicsAPIShieldAuthIDCharacteristicType = "cookie"

type ConfigurationAuthIDCharacteristicsAPIShieldAuthIDCharacteristicJWTClaim struct{…}

Auth ID Characteristic extracted from JWT Token Claims

Name string

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 ConfigurationAuthIDCharacteristicsAPIShieldAuthIDCharacteristicJWTClaimType

The type of characteristic.