Set configuration properties

PUT

https://api.cloudflare.com/client/v4/zones/{zone_id}/api_gateway/configuration

Last modified:2022-12-16 13:48:31

Request

Path Params

zone_id

string

required

Body Params application/json

auth_id_characteristics

array [object {2}]

optional

<= 10 items

name

string

required

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

<= 128 characters

Example:

authorization

type

enum<string>

required

The type of characteristic.

Allowed values:

headercookie

Example:

header

Example

{
    "auth_id_characteristics": [
        {
            "name": "authorization",
            "type": "header"
        }
    ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PUT 'https://api.cloudflare.com/client/v4/zones//api_gateway/configuration' \
--header 'Content-Type: application/json' \
--data-raw '{
    "auth_id_characteristics": [
        {
            "name": "authorization",
            "type": "header"
        }
    ]
}'

Responses

🟢200Set configuration properties response

application/json

Body

errors

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

messages

array [object {2}]

messages

required

Example:

[]

code

integer

required

>= 1000

message

string

required

result

required

Any of

allOf {2}

One of

null

object

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

Example

{
    "errors": [],
    "messages": [],
    "result": {},
    "success": true
}

🟢200Set configuration properties response failure

Modified at 2022-12-16 13:48:31

Retrieve information about specific configuration properties

Get ASN Overview