Add operations to a zone

POST

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

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

Add one or more operations to a zone. Endpoints can contain path variables. Host, method, endpoint will be normalized to a canoncial form when creating an operation and must be unique on the zone. Inserting an operation that matches an existing one will return the record of the already existing operation and update its last_updated date.

Request

Path Params

zone_id

string

required

Body Params application/json

array of:

endpoint

string <uri-template>

optional

The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.

<= 4096 characters

Example:

/api/v1/users/{var1}

Match pattern:

^/.*$

host

string <hostname>

optional

RFC3986-compliant host.

<= 255 characters

Example:

www.example.com

method

enum<string>

optional

The HTTP method used to access the endpoint.

Allowed values:

GETPOSTHEADOPTIONSPUTDELETECONNECTPATCHTRACE

Example:

GET

Example

[
    {
        "endpoint": "/api/v1/users/{var1}",
        "host": "www.example.com",
        "method": "GET"
    }
]

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cloudflare.com/client/v4/zones//api_gateway/operations' \
--header 'Content-Type: application/json' \
--data-raw '[
    {
        "endpoint": "/api/v1/users/{var1}",
        "host": "www.example.com",
        "method": "GET"
    }
]'

Responses

🟢200Add operations to a zone response

application/json

Body

result

required

Any of

allOf {2}

array[object (api-shield) {6}]

allOf {2}

One of

array[object (api-shield) {6}]

object

features

optional

endpoint

string <uri-template>

endpoint

required

<= 4096 characters

Example:

/api/v1/users/{var1}

Match pattern:

^/.*$

host

string <hostname>

host

required

RFC3986-compliant host.

<= 255 characters

Example:

www.example.com

last_updated

string <date-time>

timestamp

read-onlyrequired

Example:

2014-01-01T05:20:00.12345Z

method

enum<string>

method

required

The HTTP method used to access the endpoint.

Allowed values:

GETPOSTHEADOPTIONSPUTDELETECONNECTPATCHTRACE

Example:

GET

operation_id

string

uuid

read-onlyrequired

UUID

<= 36 characters

Example:

f174e90a-fafe-4643-bbbc-4a0ed4fc8415

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

success

enum<boolean>

required

Whether the API call was successful

Allowed value:

true

Example:

true

result_info

object

result_info

optional

count

number

optional

Total number of results for the requested service

Example:

page

number

optional

Current page within paginated list of results

Example:

per_page

number

optional

Number of results per page of results

Example:

total_count

number

optional

Total results available without any search parameters

Example:

2000

Example

{
    "errors": [],
    "messages": [],
    "result": [
        {
            "endpoint": "/api/v1/users/{var1}",
            "features": null,
            "host": "www.example.com",
            "last_updated": "2014-01-01T05:20:00.12345Z",
            "method": "GET",
            "operation_id": "f174e90a-fafe-4643-bbbc-4a0ed4fc8415"
        }
    ],
    "success": true,
    "result_info": {
        "count": 1,
        "page": 1,
        "per_page": 20,
        "total_count": 2000
    }
}

🟢200Add operations to a zone response failure

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

Retrieve information about all operations on a zone

Delete an operation