Update configuration properties

PUT/zones/{zone_id}/api_gateway/configuration

Updates API Shield configuration settings for a zone. Can modify validation strictness, enforcement mode, and other global settings.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Account API GatewayDomain API Gateway

Path ParametersExpand Collapse

zone_id: string

Identifier.

maxLength32

Query ParametersExpand Collapse

normalize: optional boolean

Ensures that the configuration is written or retrieved in normalized fashion

Body ParametersJSONExpand Collapse

auth_id_characteristics: array of object { name, type } or object { name, type }

One of the following:

APIShieldAuthIDCharacteristic = object { name, type }

Auth ID Characteristic

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

maxLength128

type: "header" or "cookie"

The type of characteristic.

One of the following:

"header"

"cookie"

APIShieldAuthIDCharacteristicJWTClaim = object { name, type }

Auth ID Characteristic extracted from JWT Token Claims

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: "jwt"

The type of characteristic.

ReturnsExpand Collapse

errors: Message { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

messages: Message { code, message, documentation_url, source }

code: number

minimum1000

message: string

documentation_url: optional string

source: optional object { pointer }

pointer: optional string

result: Configuration { auth_id_characteristics }

auth_id_characteristics: array of object { name, type } or object { name, type }

One of the following:

APIShieldAuthIDCharacteristic = object { name, type }

Auth ID Characteristic

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

maxLength128

type: "header" or "cookie"

The type of characteristic.

One of the following:

"header"

"cookie"

APIShieldAuthIDCharacteristicJWTClaim = object { name, type }

Auth ID Characteristic extracted from JWT Token Claims

maxLength128

type: "jwt"

The type of characteristic.

success: true

Whether the API call was successful.

Update configuration properties

curl https://api.cloudflare.com/client/v4/zones/$ZONE_ID/api_gateway/configuration \
    -X PUT \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $CLOUDFLARE_API_TOKEN" \
    -d '{
          "auth_id_characteristics": [
            {
              "name": "authorization",
              "type": "header"
            }
          ]
        }'

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "auth_id_characteristics": [
      {
        "name": "authorization",
        "type": "header"
      }
    ]
  },
  "success": true
}

Returns Examples

{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "result": {
    "auth_id_characteristics": [
      {
        "name": "authorization",
        "type": "header"
      }
    ]
  },
  "success": true
}